Endpoint Configuration

Owned by Morten Attermann Holst
Last updated: Oct 24, 2022 by Johannes Sebastian Nielsen
2 min read

Endpoints

Endpoints are the applications connection to the world. Most configurations will only contain one endpoint, however, multiple can be defined. In the case where multiple endpoints are defined they can be selected on the login screen in the configuration section. If only one endpoint exist, the selector is disabled.

<start>
  ...
  <endpoints>
    <endpoint id="tf-ax-05" displayName="TF-AX-05" type="DynamicsMobile" protocol="classic" companyName="dev" address="http://taskletfactory.com/DocumentService/Document.svc" default="true"/>
    <endpoint id="19" displayName="BC Sandbox Ship-it" protocol="classic" type="D365BC" address="https://api.businesscentral.dynamics.com/v2.0/cde96c81-4add-43f4-870d-641e1fe4b05b/IntegrationSandbox/WS/CRONUS%20UK%20Ltd%2e/Codeunit/MobileDocumentService" default="true">
      <azureConfiguration
        authority="https://login.windows.net/cde96c81-4add-43f4-870d-641e1fe4b05b/oauth2/authorize"
        clientId="67df0bdc-c112-4630-a900-26fe91b0c9a0"
        returnUri="https://businesscentral.dynamics.com/"
        scopes="https://api.businesscentral.dynamics.com/.default"/>
    </endpoint>
   </endpoints>
  ...
</start>
  • <endpoint> - Contains connection information to a backend

    • address = "" - The backend server url

    • companyName = "" - Company name is only used when logging in to AX, and defines the company to connect to
    • default = "false" - Sets this endpoint as the initially selected endpoint in the app if more than one are defined
    • displayName = "" - The name displayed in the settings section for selecting the endpoints in the app, and in the header on every page
    • id = "" - Must be a unique id describing the endpoint. Used to define where profile specific files are saved on the device
    • protocol = "" - Id of a protocol defined in the protocol section
    • type = "" - Endpoint server type. Accepted values are listed below. 
      • NAV - From version NAV 2013 and any Business Central version
      • AX - From version 2012
      • DynamicsMobile - NAV and AX up until version 2009

    • <azureConfiguration> - Configuration for a connection to an Azure authenticated backend
      • authority = "" - The authority with which the user information must be validated
      • clientId = "" - Client id defined in the Azure management portal for the given application
      • returnUri = "" - Return uri defined in the Azure management portal for the given application
      • serviceName = "" - Service name for Mobile WMS
      • scopes = "" - A scope is a combination of a the Azure app resource and a permission. Multiple scopes can be defined, and will be split by ;