Skip to content

Add Microsoft Graph API Support to SharePoint Connector #5833

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tinestaric wants to merge 12 commits into
base: main
Choose a base branch
from
Open

Add Microsoft Graph API Support to SharePoint Connector #5833

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
768a064
Add support for Microsoft Graph API in SharePoint Connector
Dec 15, 2025
8e7bd91
Fix parameter assignment for certificate in SetParameters method
Dec 15, 2025
a57ebea
Refactor SharePoint file operations to use SharePointAccount record i…
Dec 28, 2025
4c5b219
Implement file upload size handling in SharePoint Graph Helper
Dec 29, 2025
24f05d8
Update file upload size threshold to 4MB in SharePoint Graph Helper
Dec 29, 2025
dfbd7e5
Remove unused namespace
Dec 29, 2025
10cd320
Add validation trigger for "Use Graph API" field in SharePoint Accoun…
Bertverbeek4PS Jan 9, 2026
05295dd
Merge branch 'main' into EFS-SharepointGraphConnector
JesperSchulz Feb 11, 2026
04e3ad6
Enhance SharePoint Account table: add DataClassification for Graph AP…
Bertverbeek4PS Feb 13, 2026
fc73fe0
Rename "Use Graph API" to "Use legacy REST API" across SharePoint acc…
Bertverbeek4PS Mar 13, 2026
84a8b99
Merge branch 'main' of https://github.com/microsoft/BCApps into pr/5833
Bertverbeek4PS Mar 13, 2026
7ece6ca
Add Ext. SharePoint Upgrade codeunit to handle legacy REST API migration
Bertverbeek4PS Mar 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions ...Apps/W1/External File Storage - SharePoint Connector/App/src/ExtSharePointAccount.Page.al
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,15 @@ page 4580 "Ext. SharePoint Account"
}
}
field(Disabled; Rec.Disabled) { }
field("Use legacy REST API"; Rec."Use legacy REST API")
{
trigger OnValidate()
var
CheckBasePathMsg: Label 'The API type has been changed. Please verify that the Base Relative Folder Path is still correct for the selected API type.';
begin
Message(CheckBasePathMsg);
Copy link
Contributor

@Drakonian Drakonian Feb 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we show this message when check it from true to false?

Copy link
Contributor

@Drakonian Drakonian Feb 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, I get it now. Basically, you control both connector options with this boolean

I understand that there are no other implementations besides Legacy REST API and Graph API.

But why don't we just make it an enum value? Without using interfaces. Just to be more readable. In this case, we can, for example, make Graph API the default value, and it will look much better than boolean = true by default.

Also, maybe it will be another implementation in future, low chance, but worth to mention

Copy link
Contributor

@Bertverbeek4PS Bertverbeek4PS Feb 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if there allot of other implementation will be there and if an enum is a overkill for this

Copy link
Contributor

@JesperSchulz JesperSchulz Mar 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would probably switch this around. The boolean should now be "Use legacy REST API" and should of course we off by default.

Copy link
Contributor

@Bertverbeek4PS Bertverbeek4PS Mar 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JesperSchulz sorry I did see the comment just now.
But would you like me to change it? For me no issue 👍

Copy link
Contributor

@JesperSchulz JesperSchulz Mar 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd say we should change this, yes.

Copy link
Contributor

@Bertverbeek4PS Bertverbeek4PS Mar 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok done it. Thanks @JesperSchulz

Copy link
Contributor Author

@tinestaric tinestaric Mar 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Bertverbeek4PS I think we now need an upgrade procedure, to ensure all existing connectors are marked as using legacy REST.

Copy link
Contributor

@Bertverbeek4PS Bertverbeek4PS Mar 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes that is true! Missed that one. Forgot that this is already in use. Will add it.
Thanks @tinestaric

Copy link
Contributor

@Bertverbeek4PS Bertverbeek4PS Mar 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tinestaric done.

end;
}
}
}

Expand Down
13 changes: 12 additions & 1 deletion ...pps/W1/External File Storage - SharePoint Connector/App/src/ExtSharePointAccount.Table.al
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ table 4580 "Ext. SharePoint Account"
field(5; "Base Relative Folder Path"; Text[2048])
{
Caption = 'Base Relative Folder Path';
ToolTip = 'Specifies the folder path relative to the site collection. Start with the document library or folder name (e.g., Shared Documents/Reports). This path can be copied from the URL of the folder in SharePoint after the site collection (e.g., /Shared Documents/Reports from https://mysharepoint.sharepoint.com/sites/ProjectX/Shared%20Documents/Reports).';
ToolTip = 'Specifies the base folder path. For SharePoint REST API: Use the full server-relative path including the site (e.g., /sites/ProjectX/Shared Documents/Reports). For Microsoft Graph API: Use only the path relative to the document library (e.g., Reports). When using Graph API, the path should not include the site or document library root, only the folders within the library.';
}
field(6; "Tenant Id"; Guid)
{
Expand All @@ -50,6 +50,7 @@ table 4580 "Ext. SharePoint Account"
}
field(8; "Client Secret Key"; Guid)
{
Caption = 'Client Secret Key';
Access = Internal;
DataClassification = SystemMetadata;
}
Expand All @@ -66,13 +67,23 @@ table 4580 "Ext. SharePoint Account"
}
field(11; "Certificate Key"; Guid)
{
Caption = 'Certificate Key';
Access = Internal;
AllowInCustomizations = Never;
DataClassification = SystemMetadata;
}
field(12; "Certificate Password Key"; Guid)
{
Caption = 'Certificate Password Key';
Access = Internal;
AllowInCustomizations = Never;
DataClassification = SystemMetadata;
}
field(13; "Use legacy REST API"; Boolean)
{
Caption = 'Use legacy REST API';
DataClassification = SystemMetadata;
ToolTip = 'Specifies whether to use Microsoft Graph API or SharePoint REST API. Microsoft Graph API supports downloading files larger than 150 MB through chunked transfers. Note: Requires Microsoft Graph permissions (Sites.ReadWrite.All) configured in your app registration instead of SharePoint permissions.';
}
}

Expand Down
7 changes: 3 additions & 4 deletions ...1/External File Storage - SharePoint Connector/App/src/ExtSharePointAccountWizard.Page.al
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ page 4581 "Ext. SharePoint Account Wizard"
Caption = 'Account Name';
NotBlank = true;
ShowMandatory = true;
ToolTip = 'Specifies a descriptive name for this SharePoint storage account connection.';

trigger OnValidate()
begin
Expand All @@ -54,7 +53,6 @@ page 4581 "Ext. SharePoint Account Wizard"
field("Tenant Id"; Rec."Tenant Id")
{
ShowMandatory = true;
ToolTip = 'Specifies the Microsoft Entra ID Tenant ID (Directory ID) where your SharePoint site and app registration are located.';

trigger OnValidate()
begin
Expand All @@ -65,7 +63,6 @@ page 4581 "Ext. SharePoint Account Wizard"
field("Client Id"; Rec."Client Id")
{
ShowMandatory = true;
ToolTip = 'Specifies the Client ID (Application ID) of the App Registration in Microsoft Entra ID.';

trigger OnValidate()
begin
Expand All @@ -75,7 +72,6 @@ page 4581 "Ext. SharePoint Account Wizard"

field("Authentication Type"; Rec."Authentication Type")
{
ToolTip = 'Specifies the authentication flow used for this SharePoint account. Client Secret uses User grant flow, which means that the user must sign in when using this account. Certificate uses Client credentials flow, which means that the user does not need to sign in when using this account.';
trigger OnValidate()
begin
UpdateAuthTypeVisibility();
Expand Down Expand Up @@ -134,6 +130,9 @@ page 4581 "Ext. SharePoint Account Wizard"
IsNextEnabled := SharePointConnectorImpl.IsAccountValid(Rec);
end;
}
field("Use legacy REST API"; Rec."Use legacy REST API")
{
}

field("Base Relative Folder Path"; Rec."Base Relative Folder Path")
{
Expand Down
189 changes: 73 additions & 116 deletions ...ternal File Storage - SharePoint Connector/App/src/ExtSharePointConnectorImpl.Codeunit.al
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,8 @@

namespace System.ExternalFileStorage;

using System.DataAdministration;
using System.Integration.Sharepoint;
using System.Text;
using System.Utilities;
using System.DataAdministration;

codeunit 4580 "Ext. SharePoint Connector Impl" implements "External File Storage Connector"
{
Expand All @@ -18,9 +16,13 @@ codeunit 4580 "Ext. SharePoint Connector Impl" implements "External File Storage
Permissions = tabledata "Ext. SharePoint Account" = rimd;

var
RestHelper: Codeunit "Ext. SharePoint REST Helper";
GraphHelper: Codeunit "Ext. SharePoint Graph Helper";
ConnectorDescriptionTxt: Label 'Use SharePoint to store and retrieve files.', MaxLength = 250;
NotRegisteredAccountErr: Label 'We could not find the account. Typically, this is because the account has been deleted.';

#region File Operations

/// <summary>
/// Gets a List of Files stored on the provided account.
/// </summary>
Expand All @@ -30,28 +32,13 @@ codeunit 4580 "Ext. SharePoint Connector Impl" implements "External File Storage
/// <param name="TempFileAccountContent">A list with all files stored in the path.</param>
procedure ListFiles(AccountId: Guid; Path: Text; FilePaginationData: Codeunit "File Pagination Data"; var TempFileAccountContent: Record "File Account Content" temporary)
var
SharePointFile: Record "SharePoint File";
SharePointClient: Codeunit "SharePoint Client";
OrginalPath: Text;
SharePointAccount: Record "Ext. SharePoint Account";
begin
OrginalPath := Path;
InitPath(AccountId, Path);
InitSharePointClient(AccountId, SharePointClient);
if not SharePointClient.GetFolderFilesByServerRelativeUrl(Path, SharePointFile) then
ShowError(SharePointClient);

FilePaginationData.SetEndOfListing(true);

if not SharePointFile.FindSet() then
exit;

repeat
TempFileAccountContent.Init();
TempFileAccountContent.Name := SharePointFile.Name;
TempFileAccountContent.Type := TempFileAccountContent.Type::"File";
TempFileAccountContent."Parent Directory" := CopyStr(OrginalPath, 1, MaxStrLen(TempFileAccountContent."Parent Directory"));
TempFileAccountContent.Insert();
until SharePointFile.Next() = 0;
SharePointAccount.Get(AccountId);
if SharePointAccount."Use legacy REST API" then
RestHelper.ListFiles(SharePointAccount, Path, FilePaginationData, TempFileAccountContent)
else
GraphHelper.ListFiles(SharePointAccount, Path, FilePaginationData, TempFileAccountContent);
end;

/// <summary>
Expand All @@ -62,19 +49,13 @@ codeunit 4580 "Ext. SharePoint Connector Impl" implements "External File Storage
/// <param name="Stream">The Stream were the file is read to.</param>
procedure GetFile(AccountId: Guid; Path: Text; Stream: InStream)
var
SharePointClient: Codeunit "SharePoint Client";
Content: HttpContent;
TempBlobStream: InStream;
SharePointAccount: Record "Ext. SharePoint Account";
begin
InitPath(AccountId, Path);
InitSharePointClient(AccountId, SharePointClient);

if not SharePointClient.DownloadFileContentByServerRelativeUrl(Path, TempBlobStream) then
ShowError(SharePointClient);

// Platform fix: For some reason the Stream from DownloadFileContentByServerRelativeUrl dies after leaving the interface
Content.WriteFrom(TempBlobStream);
Content.ReadAs(Stream);
SharePointAccount.Get(AccountId);
if SharePointAccount."Use legacy REST API" then
RestHelper.GetFile(SharePointAccount, Path, Stream)
else
GraphHelper.GetFile(SharePointAccount, Path, Stream);
end;

/// <summary>
Expand All @@ -85,17 +66,13 @@ codeunit 4580 "Ext. SharePoint Connector Impl" implements "External File Storage
/// <param name="Stream">The Stream were the file is read from.</param>
procedure CreateFile(AccountId: Guid; Path: Text; Stream: InStream)
var
SharePointFile: Record "SharePoint File";
SharePointClient: Codeunit "SharePoint Client";
ParentPath, FileName : Text;
SharePointAccount: Record "Ext. SharePoint Account";
begin
InitPath(AccountId, Path);
InitSharePointClient(AccountId, SharePointClient);
SplitPath(Path, ParentPath, FileName);
if SharePointClient.AddFileToFolder(ParentPath, FileName, Stream, SharePointFile, false) then
exit;

ShowError(SharePointClient);
SharePointAccount.Get(AccountId);
if SharePointAccount."Use legacy REST API" then
RestHelper.CreateFile(SharePointAccount, Path, Stream)
else
GraphHelper.CreateFile(SharePointAccount, Path, Stream);
end;

/// <summary>
Expand All @@ -106,13 +83,13 @@ codeunit 4580 "Ext. SharePoint Connector Impl" implements "External File Storage
/// <param name="TargetPath">The target file path.</param>
procedure CopyFile(AccountId: Guid; SourcePath: Text; TargetPath: Text)
var
TempBlob: Codeunit "Temp Blob";
Stream: InStream;
SharePointAccount: Record "Ext. SharePoint Account";
begin
TempBlob.CreateInStream(Stream);

GetFile(AccountId, SourcePath, Stream);
CreateFile(AccountId, TargetPath, Stream);
SharePointAccount.Get(AccountId);
if SharePointAccount."Use legacy REST API" then
RestHelper.CopyFile(SharePointAccount, SourcePath, TargetPath)
else
GraphHelper.CopyFile(SharePointAccount, SourcePath, TargetPath);
end;

/// <summary>
Expand All @@ -123,11 +100,13 @@ codeunit 4580 "Ext. SharePoint Connector Impl" implements "External File Storage
/// <param name="TargetPath">The target file path.</param>
procedure MoveFile(AccountId: Guid; SourcePath: Text; TargetPath: Text)
var
Stream: InStream;
SharePointAccount: Record "Ext. SharePoint Account";
begin
GetFile(AccountId, SourcePath, Stream);
CreateFile(AccountId, TargetPath, Stream);
DeleteFile(AccountId, SourcePath);
SharePointAccount.Get(AccountId);
if SharePointAccount."Use legacy REST API" then
RestHelper.MoveFile(SharePointAccount, SourcePath, TargetPath)
else
GraphHelper.MoveFile(SharePointAccount, SourcePath, TargetPath);
end;

/// <summary>
Expand All @@ -138,16 +117,13 @@ codeunit 4580 "Ext. SharePoint Connector Impl" implements "External File Storage
/// <returns>Returns true if the file exists</returns>
procedure FileExists(AccountId: Guid; Path: Text): Boolean
var
SharePointFile: Record "SharePoint File";
SharePointClient: Codeunit "SharePoint Client";
SharePointAccount: Record "Ext. SharePoint Account";
begin
InitPath(AccountId, Path);
InitSharePointClient(AccountId, SharePointClient);
if not SharePointClient.GetFolderFilesByServerRelativeUrl(GetParentPath(Path), SharePointFile) then
ShowError(SharePointClient);

SharePointFile.SetRange(Name, GetFileName(Path));
exit(not SharePointFile.IsEmpty());
SharePointAccount.Get(AccountId);
if SharePointAccount."Use legacy REST API" then
exit(RestHelper.FileExists(SharePointAccount, Path))
else
exit(GraphHelper.FileExists(SharePointAccount, Path));
end;

/// <summary>
Expand All @@ -157,14 +133,13 @@ codeunit 4580 "Ext. SharePoint Connector Impl" implements "External File Storage
/// <param name="Path">The file path inside the file account.</param>
procedure DeleteFile(AccountId: Guid; Path: Text)
var
SharePointClient: Codeunit "SharePoint Client";
SharePointAccount: Record "Ext. SharePoint Account";
begin
InitPath(AccountId, Path);
InitSharePointClient(AccountId, SharePointClient);
if SharePointClient.DeleteFileByServerRelativeUrl(Path) then
exit;

ShowError(SharePointClient);
SharePointAccount.Get(AccountId);
if SharePointAccount."Use legacy REST API" then
RestHelper.DeleteFile(SharePointAccount, Path)
else
GraphHelper.DeleteFile(SharePointAccount, Path);
end;

/// <summary>
Expand All @@ -176,28 +151,13 @@ codeunit 4580 "Ext. SharePoint Connector Impl" implements "External File Storage
/// <param name="Files">A list with all directories stored in the path.</param>
procedure ListDirectories(AccountId: Guid; Path: Text; FilePaginationData: Codeunit "File Pagination Data"; var TempFileAccountContent: Record "File Account Content" temporary)
var
SharePointFolder: Record "SharePoint Folder";
SharePointClient: Codeunit "SharePoint Client";
OrginalPath: Text;
SharePointAccount: Record "Ext. SharePoint Account";
begin
OrginalPath := Path;
InitPath(AccountId, Path);
InitSharePointClient(AccountId, SharePointClient);
if not SharePointClient.GetSubFoldersByServerRelativeUrl(Path, SharePointFolder) then
ShowError(SharePointClient);

FilePaginationData.SetEndOfListing(true);

if not SharePointFolder.FindSet() then
exit;

repeat
TempFileAccountContent.Init();
TempFileAccountContent.Name := SharePointFolder.Name;
TempFileAccountContent.Type := TempFileAccountContent.Type::Directory;
TempFileAccountContent."Parent Directory" := CopyStr(OrginalPath, 1, MaxStrLen(TempFileAccountContent."Parent Directory"));
TempFileAccountContent.Insert();
until SharePointFolder.Next() = 0;
SharePointAccount.Get(AccountId);
if SharePointAccount."Use legacy REST API" then
RestHelper.ListDirectories(SharePointAccount, Path, FilePaginationData, TempFileAccountContent)
else
GraphHelper.ListDirectories(SharePointAccount, Path, FilePaginationData, TempFileAccountContent);
end;

/// <summary>
Expand All @@ -207,15 +167,13 @@ codeunit 4580 "Ext. SharePoint Connector Impl" implements "External File Storage
/// <param name="Path">The directory path inside the file account.</param>
procedure CreateDirectory(AccountId: Guid; Path: Text)
var
SharePointFolder: Record "SharePoint Folder";
SharePointClient: Codeunit "SharePoint Client";
SharePointAccount: Record "Ext. SharePoint Account";
begin
InitPath(AccountId, Path);
InitSharePointClient(AccountId, SharePointClient);
if SharePointClient.CreateFolder(Path, SharePointFolder) then
exit;

ShowError(SharePointClient);
SharePointAccount.Get(AccountId);
if SharePointAccount."Use legacy REST API" then
RestHelper.CreateDirectory(SharePointAccount, Path)
else
GraphHelper.CreateDirectory(SharePointAccount, Path);
end;

/// <summary>
Expand All @@ -226,15 +184,13 @@ codeunit 4580 "Ext. SharePoint Connector Impl" implements "External File Storage
/// <returns>Returns true if the directory exists</returns>
procedure DirectoryExists(AccountId: Guid; Path: Text) Result: Boolean
var
SharePointClient: Codeunit "SharePoint Client";
SharePointAccount: Record "Ext. SharePoint Account";
begin
InitPath(AccountId, Path);
InitSharePointClient(AccountId, SharePointClient);

Result := SharePointClient.FolderExistsByServerRelativeUrl(Path);

if not SharePointClient.GetDiagnostics().IsSuccessStatusCode() then
ShowError(SharePointClient);
SharePointAccount.Get(AccountId);
if SharePointAccount."Use legacy REST API" then
exit(RestHelper.DirectoryExists(SharePointAccount, Path))
else
exit(GraphHelper.DirectoryExists(SharePointAccount, Path));
end;

/// <summary>
Expand All @@ -244,16 +200,17 @@ codeunit 4580 "Ext. SharePoint Connector Impl" implements "External File Storage
/// <param name="Path">The directory path inside the file account.</param>
procedure DeleteDirectory(AccountId: Guid; Path: Text)
var
SharePointClient: Codeunit "SharePoint Client";
SharePointAccount: Record "Ext. SharePoint Account";
begin
InitPath(AccountId, Path);
InitSharePointClient(AccountId, SharePointClient);
if SharePointClient.DeleteFolderByServerRelativeUrl(Path) then
exit;

ShowError(SharePointClient);
SharePointAccount.Get(AccountId);
if SharePointAccount."Use legacy REST API" then
RestHelper.DeleteDirectory(SharePointAccount, Path)
else
GraphHelper.DeleteDirectory(SharePointAccount, Path);
end;

#endregion

/// <summary>
/// Gets the registered accounts for the SharePoint connector.
/// </summary>
Expand Down
Loading
Loading