Table of Contents

Set up OnRoute

To set up the OnRoute app, you need an API key. This is required for the authentication so that Business Central can display the Route Allocation information in the web interface on the mobile client which drivers use.

Contact your acadon consultant to obtain an API key for your environments.

After obtaining the API key, you can set up OnRoute via the Assisted Setup or manually via the OnRoute Setup page. Both options are described below.

Setup via Assisted Setup

  • Open the Assisted Setup either via the Assisted Setup page and then click acadon OnRoute Setup or via the notification message after installing the app in the Role Center.
  • Insert the API key when you are prompted to do so.
  • The system then checks whether the API key is valid and if it is, the app is activated and the setup is complete.
  • Further optional settings can be made in the OnRoute Setup page.

Setup via "OnRoute Setup" Page

  • Open the OnRoute Setup page via the search function.
  • Fill in the API key field with your API key.
  • Activate the Is Enabled field.
  • Use the Test API Connection action to test whether your Api Key is valid and the OnRoute Service can be reached.

Job Queue Entries

Now that the setup is complete, the following job queue entries have automatically been created.

Process Signed Delivery

Codeunit 5652306 'ACAOR Process Signed Delivery'

As soon as the app has been set up, it retrieves new information about the delivery status as well as the signed delivery documents, photos and complaints from the OnRoute Service every 10 minutes by default and attaches this information to the corresponding documents in Business Central.

Synchronize Complaints

Codeunit 5652308 'ACAOR Sync Complaints'

When the complaints and / or their translations have been changed, they are synchronized with the OnRoute Service. This is done every 60 minutes by default.