Config / Data Exchange / File Exchange Service

File Exchange Service

The Anveo EDI Connect file exchange service allows data to be received and sent by other systems. For this purpose, a service outside Dynamics is addressed, which processes the data. This service is usually run on the ServiceTier (OnPrem) installations or on a publicly accessible server (Cloud installations). For operation with Anveo EDI Connect on your own infrastructure, we offer free licenses for the service.

To use this service you need Anveo EDI Connect version 5.3.0.4 or above.

The service can be used from all installations of our module (OnPrem and Cloud) starting with Dynamics NAV 2013.

Overview

The service is delivered as a single application file. The application can be launched as a console application for testing and debugging purposes. For production operation, we recommend that the application be registered as a service. The service can be hosted on any system that is accessible from Dynamics. However, for all installations where you have access to the Dynamics ServiceTier, we strongly recommend installing it alongside the ServiceTier. The service does not support multiple instances running in parallel. So if you have multiple ServiceTiers on different machines, you should install the service on a single machine.
If the service is located on a different machine than the ServiceTier, access must be allowed via configuration and we strongly advise using an encrypted Https connection in this case. This can be set up via the configuration.

Installation the Service

Copy the AnveoFileExchangeService.exe and appsettings.json files onto a path on your server and make sure that the user who should run the service has access rights to that directory.

The application can be installed with the following command (in the console or Powershell) with administrator privileges:

sc.exe create "Anveo File Exchange Service" binpath="C:\Installation\Path\AnveoFileExchangeService.exe --contentRoot C:\Installation\Path"
Install Service

Please change C:\Installation\Path\ to the path that you have copied the application to.

For test and debugging purpose the AnveoFileExchangeService.exe can also be startet directly.

Configuration

Most of the configuration is done in Microsoft Dynamics NAV 2013R2. There are a few settings that have to be configured for the service. You can find these settings in the appsettings.json file that is supplied with the service. The configuration file has to be in the same folder as the application file.

ApiKey

Chnage this value to a long secret string and enter the same string in Dynamics. We recommend to create a GUID and remove all special characters, but it is up to you to choose a secure string. In case Http is used the secret is transferred in plain text. Please use Https when the service is not installed on the ServiceTier.

AllowLocalFilesystemAccess

Whether the service can access all local files on the server (using the user account that runs the service) and execute script files. For security reasons this is disabled by default.

SshDefaultLibrary

The default value is “Ssh.NET”. If the server uses authentication methods that are not supported by SSH.NET (like rsa-sha2-256) you can change this value to “WinSCP” in order to use that for the connection. We strongly recommend to test the connection with the WinSCP GUI (we use WinSCP version 6.1, download here: https://winscp.net/eng/download.php) if the connection can be established successfully. Regarding the key file, a .ppk key file has to be used. The program “PuTTYgen” can be used to create such a file.

AllowedHosts

Limit the access to the service to certain IPs or DNS names. (Learn more here)

Kestrel

The configuration of the service endpoint, like the address, port and whether to use Https or Http. (Learn more here)

Next Steps

You can now setup the communication channel in Anveo EDI Connect.