Incoming Web Requests

Set up the beat DTF connector

Unlock the beat DTF connector

The beat DTF connector is a component that acts as a router. This means that all incoming web requests are accepted and forwarded to your system via a central location. In the same way outgoing requests can be sent via the beat DTF connector. This has the advantage that your partners only have to send requests to one destination address.

To set up the beat DTF connector, you must enter the URL of the beat DTF connector and a requested Access Key. The setup must be done on the page Data Transfer Setup. Both values must be obtained from the consultant. After both values are entered, the general use of the beat DTF connector is activated.

Setting up an incoming connection for a partner

An incoming connection is used for one or more partners who want to transfer data to your system or request data from your system. To set up an incoming connection, open the page Incoming Connections. There you first create a new data record. The card will open. The connection is not yet usable for the beat DTF connector. You can see this by the Logged in indicator, which is not yet set. Now you have to perform the following steps.

  1. Assign a user in the field User, which will be used for each incoming web request by the beat DTF connector. The request is executed in the user context. The request therefore also considers the permissions and settings of this user.
  2. Copy the Web Service Access Key from the user card of the specified user and paste it into the field Access key. If you have not yet generated a key, follow this link to generate a key.
  3. Finally, you must press the action Sign In Connection. The connection should be logged in and the partner can now send requests to you via the beat DTF connector.
Tip

Our recommendation is to make one incoming connection and one user per partner. The identification key and the user can be used in the beat DTF connector as well as in your system to track which partner has made which requests.

Setting up functions

After you have set up the beat DTF connector and the system is set up for incoming web requests, you now need logic that processes the incoming web requests. To do this, open the Incoming Connections page and open the card of an incoming connection. In the lower part of the card you will find the Function Mappings. Here you must now enter codeunits that process functions you have specified.

Assuming you want to provide a function that lets the partner determine the inventory of an item, you can create a function assignment called GetItemInventory and a codeunit that performs the appropriate processing. The codeunit may have to be programmed or is delivered by default. The partner can then send a request to the beat DTF connector, which is structured as follows:

{
    "receiver": "Identification_Key_from_the_incoming_connection"
    "function": "GetItemInventory",
    "payload": {
        //Codeunit's defined payload
    }
}