1. To-Increase Dynamics 365 for Finance & Operations
  2. EDI studio
  3. Activities

Set up SharePoint connector
Application task

Set up a connector of type SharePoint to exchange data files between your D365 FO environment and another environment, using SharePoint. SharePoint is a solution to share and manage content, knowledge, and applications to empower teamwork, quickly find information, and seamlessly collaborate across the organization.

With the SharePoint type connector, you can exchange these external file-based documents: EDI, Fixed text, Microsoft Word, Microsoft Excel, Text, XML, JSON. You can only use this connector in combination with a document for which the version 3 (V3) handler class is selected.


Standard procedure

1. Click Connectivity studio Integration Design.
2. Click the Connectors tab.
3. Click New.
4. In the Connector field, type a value.
 

Note: You are advised to not include, in the connector name, the name of the application to which you connect. Use the Application field to define the applicable application for the connector.
5. In the Project field, enter or select a value.
6. Define the applicable application for the connector. For example, select a 'SharePoint' application.
  In the Application field, enter or select a value.
 

Note:
- You can only select an application that is defined for the applicable project. You can define project applications on the Projects page.
- You can type any existing application name, whether it is defined as project application or not. If the typed application is not defined as project application, it is automatically added to the project applications.
7. In the Connector type field, select 'SharePoint'.
8. Sub-task: Set properties.
  8.1 You can export connectivity setup and import it in another D365 FO environment. For example, you first set up and test the connectivity setup in a development environment. When finished, you deploy the setup in your production environment.
To prevent messing up your production data, use different file locations for your development or testing environment and for your production environment.
To strictly distinguish between different environments, you can define unique connector properties, read settings, and write settings for each of your environment types.
Which properties, read setting, and write settings are applicable to the current environment is defined in the Environment type field on the Connectivity studio parameters. Example: If set to Development, the connector properties, read settings, and write settings, as defined for environment type Development are applicable.
  In the Environment types field, select an option.
 

Note: The environment types only apply to connectors of type Database, Azure file storage, Blob storage, SharePoint, or Service Bus queue.
  8.2 Expand the Properties section.
  8.3 In the Tenant ID field, enter the Directory (tenant) ID of the registered Microsoft Entra ID application that you use to grant Microsoft Graph permissions.
  8.4 In the Drive Name field, enter the name of the SharePoint drive where the connector file folders are located.
 

Note: You can only use the Drive name if the drive is directly connected to the SharePoint root site. If the drive is not directly connected to the SharePoint root site, use the Drive ID.
  8.5 If the drive is not directly connected to the SharePoint root site, use the Drive ID instead of the Drive name. You can use the Drive ID to connect to a document library (drive) of a SharePoint subsite.
  In the Drive Id field, type a value.
  8.6 Define how access to SharePoint is granted:
- Client credentials: Fill in the 'Client ID' and 'Consumer secret' or 'Consumer secret reference' fields.
- Password: Fill in the 'Client ID', 'User name', and 'Password' or 'password reference' fields.
  In the Grant type field, select an option.
  8.7 In the Client ID field, enter the Application (client) ID of the registered Azure AD application that you use to grant Microsoft Graph permissions.
  8.8 Enter the consumer secret or consumer secret reference of the registered Azure AD application that you use to grant Microsoft Graph permissions.
Whether the consumer secret or consumer secret reference applies is defined by the Display secret field in the Connectivity studio parameters.
If the Display secret parameter is set to:
- Secret, fill in the Consumer secret field with the desired client secret. The client secret is specific for the current connector.
- Secret reference, fill in the Consumer secret reference field with the desired secret reference. The consumer secret reference refers to a centrally stored client secret which makes updating secrets easier.
- Both, fill in either the Consumer secret field or the Consumer secret reference field.
  In the Consumer secret field, or in the Consumer secret reference field, type a value.
 

Note: This field is only applicable if the grant type is 'Client credentials'.
  8.9 In the User name field, enter the user name that is used to access the Azure AD application that you use to grant Microsoft Graph permissions.
 

Note: This field is only applicable if the grant type is 'Password'.
  8.10 Enter the password or password reference of the registered Azure AD application that you use to grant Microsoft Graph permissions.
Whether the password or password reference applies is defined by the Display secret field in the Connectivity studio parameters.
If the Display secret parameter is set to:
- Secret, fill in the Password field with the desired client secret. The password is specific for the current connector.
- Secret reference, fill in the Password reference field with the desired secret reference. The password reference refers to a centrally stored client secret which makes updating secrets easier.
- Both, fill in either the Password field or the Password reference field.
  In the Password hash field, or in the Password reference field, type a value.
 

Note: This field is only applicable if the grant type is 'Password'.
  8.11 For the used Azure AD application, Microsoft Graph permissions are defined. You can use the scope to prompt consent for specific permissions for this connection. For example, Files.ReadWrite.All, Sites.ReadWrite.All, or User.Read.
If you want to prompt consent for all required Microsoft Graph permissions of the registered application, enter: .default.
  In the Scope field, type a value.
  8.12 Define the path, within the SharePoint drive, to the folder where the connector file folders are located.
Example:
The full working folder path is: [Tenant]/[Drive]/ConnectorFolders/ExampleConnector/Working.
In the File path field, enter: ConnectorFolders/ExampleConnector
  In the File path field, type a value.
  8.13 Enter the path to the Working folder of the connector.
If a message:
- Imports files, this is the source folder.
- Exports files, this is the target folder.
  In the Working path field, enter or select a value.
 

Note: Manually create the Working folder in the defined file path on SharePoint.
  8.14 Enter the path to the Archive folder of the connector.
Files are:
- Moved to the Archive folder when imported without errors.
- Copied to the Archive folder on export. If you export, the file is first created in the Working folder. When created, it is copied to the Archive folder.
  In the Archive path field, enter or select a value.
 

Note: Manually create the Archive folder in the defined file path on SharePoint.
  8.15 A message is always run for a specific company. Usually, this is the current company. You can store the message files in a separate folder for each company. As a result, if you run a message to:
- Import files, it only searches for files in the folder for the company for which the message is run. Example: The message is run for company USMF. Files are only searched for in the [working path]\USMF folder.
- Export files, the files are stored in the folder for the company for which the message is run. Example: The message is run for company USMF. Files are stored in the [working path]\USMF folder.
  Select Yes in the Use company folders field.
 

Note:
If you use company folders, manually create the company folders.
Make sure the:
- Company folder names are exactly the same as the company IDs in D365 FO.
- Company folders are defined for each path folder of the connector: Working, Archive, Error, Split-Temporary (if applicable), and Temporary (if applicable).
9. Sub-task: Set read options.
  9.1 Expand the Read section.
  9.2 Enter the path to the Error folder of the connector.
If, on import of a file, errors occur, the file is moved to the Error folder.
  In the Error path field, enter or select a value.
 

Note: Manually create the Error folder in the defined file path on SharePoint.
  9.3 Enter the path to the Split-Temporary folder of the connector.
On import, you can split large files with a lot of records. Whether a file must be split is defined in the Split quantity field on documents of type Text or Microsoft Excel. As a result, the original file is put in the Split folder instead of the Working folder. When the message is run, the original file is split in smaller files based on the split quantity. The smaller split files are put in the Working folder. The message processes the split files in parallel.
  In the Split/Temporary path field, enter or select a value.
 

Note:
- Manually create the Split-Temporary folder in the defined file path on SharePoint.
- Only use the split functionality for simple (one record level) data. It is not suitable for data with multiple levels (header and line records).
10. Sub-task: Set write options.
  10.1 Expand the Write section.
  10.2 In the Temporary path field, enter or select a value.
 

Note: Manually create the Temporary folder in the defined file path on SharePoint.
11. Sub-task: Select custom handler.
  11.1 Expand the Custom section.
  11.2 For a SharePoint type connector, the standard handler class is BisConnectorStreamSharepoint. This handler class exports data to or imports data from a file.
You can use a customized handler class. To do so, extend the standard handler class.
  In the Handler field, enter or select a value.
12. Sub-task: Set advanced options.
  12.1 Expand the Advanced options section.
  12.2 A document can have a query for which cross-company is enabled. If a user, with access to a restricted set of companies, runs a message that uses the document, the cross-company option does not work. If you have this scenario, make sure the cross-company option is enabled for the used connector. Otherwise, you can disable the cross-company option.
  Select Yes in the Cross company disabled field.
13. Close the page.

Notes

You can test the connection. To do so, on the Connectors page, in the Action Pane, on the Development tab, click Test connection.

See also

Provide feedback