How To Set Up Communication Methods

It is possible to set which method should be used to communicate with an external system to exchange data. It is, for example, possible to specify S/Ftp, Ftp, Azure File Storage, Azure Blob Storage and SharePoint Online.

Tip

Choose the Select file and Import action on the Integrations and Integration Queue page for a quick and easy way to import a file without setting up a communication method.

SharePoint Online

The steps for setting communication to SharePoint Online can be done in different ways. Step 3 and Step 4 is only necessary if you want to use a custom app registration instead of the app registration provided by SmartApps and the default settings created automatically.

Step 1: Create New Communication Method

Start by creating a new communication method and with the Type SharePoint:

  1. Choose the search icon (ALT+Q), enter Communication Methods, and then choose the related link.
  2. Select New.
  3. Enter a Code and select SharePoint in the Type field.
  4. Change the Description if necessary.

Step 2: Enter Details for SharePoint

  1. Select the Edit action on the Communication Method page.
  2. Enter the full address of the site on which the document library is located in the Site URL field.
  3. Enter the path to the document library located on the site, in the Site Relative URL field.
  4. It is possible, but not necessary, to specify a File Filter.
  5. A Credential Code with default settings is created automatically after the Site URL is specified. It is possible to create a Credential Code, but it is only necessary if you want to use a custom app registration.
Note
Field - Site URL

The Site URL must contain the full address of the site on which the document library is located (don´t include the document library). Example: If the document library is located on "SubSite":https://YourDomain.sharepoint.com/sites/SubSite/

Field - Site Relative URL

Enter the path to the folder in the document library (don´t include the Site URL). Example: If the document library on "SubSite" (see above) is named "Shared Documents" and contains a subfolder, then the Site Relative URL field should (only) contain: Shared Documents/SubFolder/

Summary of Fields - Site URL & Site Relative URL

Site URL and Site Relative URL should together contain the address of the SharePoint site and document library. Copy both fields and paste into the browser to check that you entered them correctly.

Field - File Filter

You can distinguish files imported from the same folder by adding a File Filter. It can be useful when the same folder is used for files belonging to different companies or integrations.

Action - Show Files

You can use the Show Files action to verify that you can access the specified location with the current settings and permissions. It is also useful for checking that the specified File Filter works as intended.

Step 3: Create a Credential Code

This only applies if you want to use a custom app registration. Otherwise you can skip this step (and step 4) and use the app registration from SmartApps and the default settings instead.

  1. Select New on the drop down list in the Credential Code field.
  2. Enter a Code and a Description.
  3. Select Microsoft OAuth2 Authorization Code in the Authorization Method field.
  4. Enter the Client Id and Client Secret from the Azure App Registration.
  5. Enter the AAD Tenant Id of the SharePoint Site.
  6. It is not necessary to enter the Redirect Url.
  7. Select the OAuth Scopes and action and the choose the Add Scope for SharePoint Online action to add the scope for connecting to SharePoint Online.
Note
Field - Client Id

Copy the Application (client) ID from the App Registration on the Overview page.

Field - Client Secret

Copy the Value from the App Registration on the Certificates & secrets page.

Field - AAD Tenant Id

A Tenant ID (tenant identifier) is a unique identifier or alias for the tenant. Copy the Microsoft Entra tenant ID guid in Business Central on the Help & Support page under Report a problem if the SharePoint site is on the same tenant as Business Central.

Step 4: Create Azure App Registration

This step (and step 3) only applies if you want to use a custom app registration. Otherwise you can skip this step (and step 3) and use the app registration from SmartApps and the default settings instead.

Perform the steps below to create a custom Application (client) ID and secret to use for the SharePoint Communication Method in Spider.

  1. Create a new App Registration in the Microsoft Entra admin center.
  2. For the new registration:
    1. Enter a suitable name.
    2. Select account type:
      1. Spider supports Single tenant and Multitenant.
    3. Add Redirect URI:
      1. Select platform Web.
      2. Enter https://businesscentral.dynamics.com/OAuthLanding.htm as URI.
  3. Add API permissions for the created app registration:
    1. Select the SharePoint API.
      1. Select Delegated Permissions.
      2. Add permission: AllSites.Write.
  4. Create a new secret.
Note

Copy the Application (client) ID and secret since they are needed to set up the SharePoint Communication Method in Business Central on the Communication Method Credential page.

Step 5: Check The Settings

You can use the Show Files action on the SharePoint Communication Method Card to verify that you can access the specified location with the current settings and permissions.

Ftp and S/Ftp

Create New Communication Method

Start by creating a new communication method and with the Type Ftp or S/Ftp:

  1. Choose the search icon (ALT+Q), enter Communication Methods, and then choose the related link.
  2. Select New.
  3. Enter a Code and select Ftp or S/Ftp in the Type field.
  4. Change the Description if necessary.
  5. Select the Edit action on the Communication Method page and fill in the fields as necessary. Hover over a field to read a short description.
Note

If the Use Custom API field on the Custom API FastTab is left disabled the API provided by SmartApps will be used. The Ftp and S/Ftp services provided by SmartApps is behind a fixed IP address: 20.105.42.47. This can be used to only allow the selected IP to connect to the server.

Tip

You can use the Show Files action to verify that you can access the specified location with the current settings. It is also useful for checking that the specified File Filter works as intended.

See Also

How To Set Up File Imports
External Systems
Integration Queue
Extra Fields
Web Services Integrations