Save manual as PDF or print  


XML Builder


Export data in XML format (or JSON) via fully configurable schemas.

Manual


Creation date: 2026/05/21
The current version of this manual can be found at:

https://www.navax.app/help.php?AppID=NCXML&L=en


☰ Contents



General

  • XML Builder
    XML Builder extends Microsoft Dynamics 365 Business Central with fully configurable XML Schemas. The schemas can then be used to export data to a file or to retrieve data via an API...

Setup

  • XML Builder Setup
    In the XML Builder Setup page the general settings and defaults for the XML Builder...

Working with the App

  • XML Builder Schemas
    More information will follow soon...
  • Schema Lines
    More information will follow soon...
  • Root Line Settings
    More information will follow soon...
  • Table Settings
    More information will follow soon...
  • Field Settings
    More information will follow soon...
  • Variables
    More information will follow soon...
  • Conditions
    More information will follow soon...
  • Calculations
    More information will follow soon...
  • Download Area
    The Download Area provides a selection of schemas that you can download and use...
  • Copy, Export & Import

Information for Developers

  • API
    Files can also be generated externally using the XML Builder via an API. The created file is returned in Base64 format. For a schema to be visible in the API resp. for the file to be created via the API, the Allow API Access field must be specified for the XML Schema...

Appendix

  • NAVAX License Management
    The NAVAX License Management page (in older versions NAVAX License Overview or NCEX License Overview) displays the current license status of the NAVAX extensions...
  • Installation Notes
  • Release Notes

Docs  /  App  /  XML Builder  /  General
 XML Builder

XML Builder extends Microsoft Dynamics 365 Business Central with fully configurable XML Schemas. The schemas can then be used to export data to a file or to retrieve data via an API.

Navigation

XML Builder can be accessed from any role via the Search function. The search terms "xmlbuilder", "nvxxml", "ncxml" and "navax" are also recognized by "Tell me what you want to do".

Note

The XML Builder was developed with the prefix NCXML resp. NVXXML. NCXML resp. NVXXML stands for NAVAX Consulting resp. NAVAX XML Builder.

Permission Sets

The following permission sets are available for the XML Builder:
NameDescription
NVXXMLXML Builder You need these permissions to use the XML Builder.
NVXXML, SETUPXML Builder Setup You need these permissions to set up the XML Builder.
NVXXML, APIXML Builder API If files are also to be created via the API, this permission set must be added to the Microsoft Entra Application or, in the case of an on-premises installation, to the API user. For more information, see Information for Developers, API.

Installation Notes

For more information, see Appendix, Installation Notes.

Docs  /  App  /  XML Builder  /  Setup
 XML Builder Setup

In the XML Builder Setup page the general settings and defaults for the XML Builder.

General, Fields
Disable API AccessSpecifies whether API access should be disabled. For more information, see Information for Developers, API.

Einrichtung, Actions

System, Actions

  • NAVAX License Management

    Opens the NAVAX License Management which displays the current license status of the NAVAX extensions. For more information, see Appendix, NAVAX License Management.

Docs  /  App  /  XML Builder  /  Working with the App
 XML Builder Schemas

More information will follow soon.

Docs  /  App  /  XML Builder  /  Working with the App
 Schema Lines

More information will follow soon.

Docs  /  App  /  XML Builder  /  Working with the App
 Root Line Settings

More information will follow soon.

Docs  /  App  /  XML Builder  /  Working with the App
 Table Settings

More information will follow soon.

Docs  /  App  /  XML Builder  /  Working with the App
 Field Settings

More information will follow soon.

Docs  /  App  /  XML Builder  /  Working with the App
 Variables

More information will follow soon.

Docs  /  App  /  XML Builder  /  Working with the App
 Conditions

More information will follow soon.

Docs  /  App  /  XML Builder  /  Working with the App
 Calculations

More information will follow soon.

Docs  /  App  /  XML Builder  /  Working with the App
 Download Area

The Download Area provides a selection of schemas that you can download and use.

Note

The following example shows the XML Builder Download Area of the NAVAX extension E-Document - ebInterface.
Via the Download action a schema can be downloaded and created.

Fields
CodeSpecifies the code of the schema.
DescriptionSpecifies the description of the schema.
InformationDisplays information about the schema.
Zip FileIndicates whether multiple schemas are combined in a zip file.
NewIndicates whether the schema was recently added to the Download Area.
Date ModifiedSpecifies when the schema was last modified.

Actions

  • Download

    Via this action the schema can be downloaded and created. This will open the import page where further settings can be made.

Docs  /  App  /  XML Builder  /  Working with the App
 Copy, Export & Import

Note

The following examples shows the XML Builder Schemas of the NAVAX extension E-Document - ebInterface.

Copy

Via this action, a copy of the schema can be created.

  • Copy from
    CodeSpecifies the code of the existing schema to copy from.
    DescriptionSpecifies the description of the existing schema.

    Copy to
    CodeSpecifies the code for the new schema.
    Code already ExistsSpecifies whether a schema with the code already exists. An additional confirmation is necessary for replacing a schema.
    DescriptionSpecifies a description for the new schema.

Export

This action can be used to export a schema to a file or multiple selected schemas to a zip file.

  • Export from
    CodeSpecifies the code of the schema to be exported.
    DescriptionSpecifies the description of the schema to be exported.
    Selected SchemasSpecifies the number of selected schemas. The field is only displayed when schemas are exported to a zip file.

    Export to
    File NameSpecifies the name for the file.

    Note

    XML Builder Schema files have the file extension .ncxmls. NCXMLS stands for NAVAX Consulting XML Builder Schema.

Import

This action can be used to import a schema from a file or multiple schemas from a zip file.

  • Import from

    ProgressShows the progress when importing from a zip file. The field is only displayed when schemas are imported from a zip file.
    DescriptionSpecifies the description of the schema to be imported.

    Import to
    CodeSpecifies the code for the new schema.
    Code already ExistsSpecifies whether a schema with the code already exists. An additional confirmation is necessary for replacing a schema.
    Import all with specified CodeSpecifies whether all schemas for which a code is specified should be automatically imported with that code if no schema with that code yet exists. The field is only displayed when schemas are imported from a zip file.

Docs  /  App  /  XML Builder  /  Information for Developers
 API

Files can also be generated externally using the XML Builder via an API. The created file is returned in Base64 format. For a schema to be visible in the API resp. for the file to be created via the API, the Allow API Access field must be specified for the XML Schema. For more information, see Working with the App, XML Builder Schemas.

Note

If necessary, you can also completely disable API access at any time in the XML Builder Setup. For more information, see Setup, XML Builder Setup.

Endpoint

To access the XML Builder via the API, use the following information:
Publishernavax
GroupxmlBuilder
Versionv2.0
EndpointxmlSchemas

List of XML Schemas

A list of all XML schemas for which API access is permitted can be retrieved via a GET request. URL structure https://api.businesscentral.dynamics.com/v2.0/{tenant}/{environment}/api/navax/xmlBuilder/v2.0/companies({id})/xmlSchemas Example https://api.businesscentral.dynamics.com/v2.0/0e12x34c-e5le-678x-c912-34567890e12l/NAVAXAppsSandbox/api/navax/xmlBuilder/v2.0/companies(c2d9d41e-19ab-ec11-bb8f-000d3a231900)/xmlSchemas Result 
{
    "@odata.context": "https://api.businesscentral.dynamics.com/v2.0/0e12x34c-e5le-678x-c912-34567890e12l/NAVAXAppsSandbox/api/navax/xmlBuilder/v2.0/$metadata#companies(c2d9d41e-19ab-ec11-bb8f-000d3a231900)/xmlSchemas",
    "value": [
        {
            "@odata.etag": "W/\"JzE5OzMxMDQ5Njc5Nzc5MjgyNzY5NDIxOzAwOyc=\"",
            "code": "CUST",
            "description": "Customers incl. Entries",
            "comments": "API Test",
            "filter": "{ \"No.\": \"Code\", \"Salesperson Code\": \"Code\" }"
        },
        {
            "@odata.etag": "W/\"JzE3Ozc2NTU2NDM4NTIxNjcwNjE3MTswMDsn\"",
            "code": "SINV",
            "description": "Sales Invoice",
            "comments": "API Test",
            "filter": "{ \"No.\": \"Code\" }"
        }
    ]
}

Create and retrieve file

The file for a schema can be created and retrieved via a POST request. The resulting file is returned in Base64 format. URL structure https://api.businesscentral.dynamics.com/v2.0/{tenant}/{environment}/api/navax/xmlBuilder/v2.0/companies({id})/xmlSchemas('{code}')/Microsoft.NAV.GetFileAsBase64 Example https://api.businesscentral.dynamics.com/v2.0/0e12x34c-e5le-678x-c912-34567890e12l/NAVAXAppsSandbox/api/navax/xmlBuilder/v2.0/companies(c2d9d41e-19ab-ec11-bb8f-000d3a231900)/xmlSchemas('TEST')/Microsoft.NAV.GetFileAsBase64 Result 
{
    "@odata.context": "https://api.businesscentral.dynamics.com/v2.0/0e12x34c-e5le-678x-c912-34567890e12l/NAVAXAppsSandbox/api/navax/xmlBuilder/v2.0/$metadata#Edm.String",
    "value": "UEsDBBQAAAAIADo7h1xFpqSDDAUAAFgZAAAYAAAAeGwvd29ya3NoZWV0cy9zaGVldDEueG1...gAAAAAA=="
}

Set Filters

TODO

Permission Set

The following permission set is available for the API:
NVXXML, APIXML Builder API To enable files to be created via the API, this permission set must be added to the Microsoft Entra Application or, in the case of an on-premises installation, to the API user.

Docs  /  App  /  XML Builder  /  Appendix
 NAVAX License Management

The NAVAX License Management page (in older versions "NAVAX License Overview" or "NCEX License Overview") displays the current license status of the NAVAX extensions.

Fields
NameSpecifies the name of the Extension.
License StatusSpecifies the current license status of the Extension.
Serial No.Specifies the serial number of the Extension.
VersionSpecifies the currently installed version of the Extension.

Trial Version

A NAVAX extension can be tested or used free of charge for 30 days after installation. After that, the extension can only be used with a valid license.

Request License

The license can be requested or checked via the Current Status action. This opens a new page. The following example shows the NAVAX extension Excel Report Builder. Fill in the fields in the page and then click Send License Request. Please note that the licensing process may take some time. In the next few days you will receive an email with further information.

Note

For licensing, calling the online help and performing some actions, access to https://www.navax.app must be granted.

Public IP from www.navax.app for setting firewall access:
94.136.22.236, Port: TCP/443

Checking the connection to https://www.navax.app using PS:
Test-NetConnection navax.app -port 443
(PS must be performed with the M-Tier service user)

CRL Servers
In addition, the following CRL Servers must also be accessible for the certificate check:
https://certificates.godaddy.com/*
http://crl.godaddy.com/*
or their IP: 192.124.249.36

Activate/Update License

As soon as the licensing has been completed, you will receive an email and the license can be activated via the Update License action. The license is company independent. So it does not matter in which company the action is called.

Note

  • The licence must be updated once a year via the Update License action.
  • The update is only possible or necessary within the last 30 days before the license expires, or afterwards. Within the last 30 days before the license expires, notes are displayed.
  • If the Automatic License Renewal is enabled, the Update License action is called automatically before the license expires. During this process, all licenses for which automatic license renewal is enabled are checked and updated if necessary. If automatic renewal is not successful, notifications will be displayed within the last 15 days before the license expires. Note that the setting is only active after the license has been activated.

Terms & Conditions

For more information, see https://www.navax.app/EULA.php?L=en

Data Security

For more information, see https://www.navax.app/privacyStatement.php?L=en

Submit Rating

This action can be used to open the Microsoft AppSource ratings page for the extension. We would be very happy if you submit your rating and let us know about your experience with the Extension.

Docs  /  App  /  XML Builder  /  Appendix
 Installation Notes

Publish and Install the Extension


All necessary steps are described here:
[Microsoft Learn] Business Central - Publishing and Installing an Extension

Dependencies

On-Premises

The following Granules are required for an On-Premises installation:
  • 70714860 NAVAX XML Builder
  • 1010860 NAVAX Extension Base

External Addresses

  • https://www.navax.app

    For licensing, calling the online help and performing some actions, access to https://www.navax.app must be granted.

    Public IP from www.navax.app for setting firewall access:
    94.136.22.236, Port: TCP/443

    Checking the connection to https://www.navax.app using PS:
    Test-NetConnection navax.app -port 443
    (PS must be performed with the M-Tier service user)

    CRL Servers
    In addition, the following CRL Servers must also be accessible for the certificate check:
    https://certificates.godaddy.com/*
    http://crl.godaddy.com/*
    or their IP: 192.124.249.36

Docs  /  App  /  XML Builder  /  Appendix
 Release Notes

Would you like to know what has changed in the extension?
Below you'll find an overview of the new features and changes made in the updates.

Version 26.1.0.0

  • Initial Version

  Save manual as PDF or print  
DE|EN Imprint