Add Microsoft Graph API Support to SharePoint Connector by tinestaric · Pull Request #5833 · microsoft/BCApps

tinestaric · 2025-12-15T11:12:18Z

Summary

Add Microsoft Graph API Support to SharePoint Connector

BC Idea

Implements Idea #21d4bf5c-d7b4-f011-aa43-7c1e52a6c1f4

Problem Statement

Business Central limits the maximum HTTP response content size to 150 MB by default (controlled by the NavHttpClientMaxResponseContentSize server setting). This limitation causes file downloads from SharePoint to fail for files larger than this threshold.

While chunked downloads would solve this issue, SharePoint REST APIs do not support chunked downloads (only uploads). Microsoft Graph API, however, does support this capability.

Solution

This PR introduces Microsoft Graph API support as an alternative implementation alongside the existing SharePoint REST API, with a backward-compatible toggle to switch between the two.

Changes

New field: Added "Use Graph API" toggle in ExtSharePointAccount.Table.al and ExtSharePointAccount.Page.al to control API selection
Improved UX: Updated tooltips to clarify folder path requirements for both APIs
Refactored implementation: Modified ExtSharePointConnectorImpl.Codeunit.al to route operations based on API selection
New codeunits:
- ExtSharePointGraphHelper.Codeunit.al: Encapsulates Graph API operations for files and directories
- ExtSharePointRestHelper.Codeunit.al: Encapsulates existing REST API operations
Bug fix: Fixed certificate parameter assignment in GraphAuthClientCredentials.Codeunit.al that prevented certificate-based authentication from working correctly

Backward Compatibility

The existing SharePoint REST API implementation remains the default option, ensuring no breaking changes for current users. The Graph API can be enabled per account configuration.

Dependencies

Depends on SharePoint module additions in the System Application (see #3655)

Benefits

Removes file size limitations: Graph API supports downloading files larger than 150 MB through chunked downloads
Flexibility: Users can choose the API that best fits their requirements
Clean permissions model: App registration can use either SharePoint REST or Graph API permissions without mixing
Backward compatible: Existing implementations continue to work without changes

Work Item(s)

Fixes #5383

Fixes AB#612932

- Introduced a new field "Use Graph API" in Ext. SharePoint Account table and page to toggle between SharePoint REST API and Microsoft Graph API. - Updated tooltips for clarity on folder paths for both APIs. - Refactored Ext. SharePoint Connector implementation to utilize Graph API for file operations, including ListFiles, GetFile, CreateFile, CopyFile, MoveFile, FileExists, and DeleteFile. - Created Ext. SharePoint Graph Helper codeunit to encapsulate Graph API logic for file and directory operations. - Added Ext. SharePoint REST Helper codeunit for existing REST API operations. - Ensured compatibility with existing functionality while providing an option to leverage Microsoft Graph API for enhanced performance and capabilities.

Copilot

Pull request overview

This PR adds Microsoft Graph API support to the SharePoint Connector as an alternative to the existing SharePoint REST API implementation. The enhancement addresses Business Central's 150 MB HTTP response limit by enabling chunked downloads through Microsoft Graph API, which supports this capability unlike SharePoint REST APIs.

Key Changes:

Introduces a "Use Graph API" toggle to switch between REST and Graph API implementations
Refactors connector logic to route operations based on API selection
Adds new helper codeunits to encapsulate Graph and REST API operations separately

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
ExtSharePointAccount.Table.al	Adds "Use Graph API" boolean field with improved tooltips explaining path requirements for both APIs
ExtSharePointAccount.Page.al	Updates UI to display the new "Use Graph API" toggle
ExtSharePointConnectorImpl.Codeunit.al	Implements routing logic to delegate operations to appropriate helper based on API selection
ExtSharePointGraphHelper.Codeunit.al	New codeunit encapsulating all Microsoft Graph API file operations
ExtSharePointRestHelper.Codeunit.al	New codeunit encapsulating existing SharePoint REST API operations
GraphAuthClientCredentials.Codeunit.al	Bug fix for certificate parameter assignment in authentication

Note: Since this PR depends on System Application changes (PR #3655) and I cannot view the actual diff of changes, I cannot provide specific code-level review comments. The PR appears well-structured based on the description, maintains backward compatibility by keeping REST API as the default, and follows a clean separation of concerns by creating dedicated helper codeunits for each API implementation.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

tinestaric · 2025-12-15T11:21:24Z

@IceOnly @StefanSosic
If you're not already enjoying the holidays, as two of the most involved with the connectors, I'd appreciate your reviews here.

@JesperSchulz
While adding GraphAPI support, I also identified a bug in one of the SystemApp modules. I wasn't sure whether to open a separate PR for that bug fix or include it in this one as well.

IceOnly

Looks good!
I’ll try to test it at the end of the week.
Only suggestion:
It might make sense to replace the "Use Graph API" boolean with an enum, add an interface, and use that interface to select the correct helper. This could make the design more flexible and easier to extend later.

JesperSchulz · 2025-12-15T15:32:37Z

@IceOnly @StefanSosic If you're not already enjoying the holidays, as two of the most involved with the connectors, I'd appreciate your reviews here.

@JesperSchulz While adding GraphAPI support, I also identified a bug in one of the SystemApp modules. I wasn't sure whether to open a separate PR for that bug fix or include it in this one as well.

Including bug fix here should be fine!

StefanSosic · 2025-12-15T15:45:42Z

@IceOnly @StefanSosic If you're not already enjoying the holidays, as two of the most involved with the connectors, I'd appreciate your reviews here.

@JesperSchulz While adding GraphAPI support, I also identified a bug in one of the SystemApp modules. I wasn't sure whether to open a separate PR for that bug fix or include it in this one as well.

I will also take a look. No holidays for me yet 😊

tinestaric · 2025-12-15T16:08:51Z

Looks good! I’ll try to test it at the end of the week. Only suggestion: It might make sense to replace the "Use Graph API" boolean with an enum, add an interface, and use that interface to select the correct helper. This could make the design more flexible and easier to extend later.

Thanks!
I've actually been juggling the idea of the interface, but I was a bit reluctant. I couldn't foresee any additional options beyond the Rest and Graph APIs for connecting to SharePoint. And if there are only two, do I want to add the additional abstraction for abstraction's sake.

This comment isn't a no; I'm open to switching to an interface, but it's more of a discussion. Where would you see it extended in the future?

...W1/External File Storage - SharePoint Connector/App/src/ExtSharePointGraphHelper.Codeunit.al

.../External File Storage - SharePoint Connector/App/src/ExtSharePointConnectorImpl.Codeunit.al

…nstead of AccountId

pri-kise · 2026-01-02T07:50:49Z

src/Apps/W1/External File Storage - SharePoint Connector/App/src/ExtSharePointAccount.Page.al

                }
            }
            field(Disabled; Rec.Disabled) { }
+            field("Use Graph API"; Rec."Use Graph API") { }


If someone selects or deselects this field then Base Relative Folder Path maybe needs to be updated.
I'm not sure about the best behaviour.
The less intrusive would be a notification to check if the Base Relative Folder Path is still correct setup.

This comment is explicit for the Card page that someone opens for an existing setup.

@pri-kise I now added a warning. But mostly in allot of cases the field is blanket out so the user need to fill it in again.

pri-kise · 2026-01-02T07:55:16Z

...s/W1/External File Storage - SharePoint Connector/App/src/ExtSharePointAccountWizard.Page.al

                end;
            }
+
+            field("Use Graph API"; Rec."Use Graph API")


I understand why you added the field at the end.
It's a new setup field.

Since this fields has an influence on the Base Relative Folder Path I would suggest to add this field before the field Base Relative Folder Path. Otherwise a user might need to updat the path field once again afterwards.

I did even thought if it would be better to have an additional step before the common setup for both where a user must select this new option. (Currently I'm not sure if this would be really better)

Done. Thanks!

JesperSchulz

This looks good to me! Once Kilian's comments have been addressed, I think we're ready to push this forward!

JesperSchulz · 2026-01-07T11:45:33Z

...W1/External File Storage - SharePoint Connector/App/src/ExtSharePointGraphHelper.Codeunit.al

+        if Path = '' then
+            Path := '/';
+
+        SharePointGraphClient.GetItemsByPath(Path, GraphDriveItem);


In all other calls, we use the return value:

Response := SharePointGraphClient.DeleteItemByPath(Path); if not Response.IsSuccessful() then ShowError(Response);

Just checking that you're deliberately not doing that here.

JesperSchulz · 2026-01-07T11:48:58Z

...W1/External File Storage - SharePoint Connector/App/src/ExtSharePointGraphHelper.Codeunit.al

+
+    internal procedure ListFiles(SharePointAccount: Record "Ext. SharePoint Account"; Path: Text; FilePaginationData: Codeunit "File Pagination Data"; var TempFileAccountContent: Record "File Account Content" temporary)
+    var
+        GraphDriveItem: Record "SharePoint Graph Drive Item";


In ListDirectories you're using a temp record. Here not. Is that intentional?

…t pages

Bertverbeek4PS · 2026-01-09T11:52:24Z

@JesperSchulz since @tinestaric is on holiday for 3 months I have talked to him that I would resolve any comments.
(it is a request from the extension project of 4PS)
But I'm no maintainer at his branche 👎 . So how can we proceed?

tinestaric · 2026-01-09T14:55:42Z

@Bertverbeek4PS made you a collaborator on the fork. :)

Bertverbeek4PS · 2026-01-09T15:00:30Z

@Bertverbeek4PS made you a collaborator on the fork. :)

Thanks allot @tinestaric

JesperSchulz · 2026-02-11T13:52:17Z

Syncing repo.

Drakonian · 2026-02-11T14:02:17Z

...stem Application/App/MicrosoftGraph/src/Authorization/GraphAuthClientCredentials.Codeunit.al

        AadTenantId := NewAadTenantId;
        ClientId := NewClientId;
-        Certificate := Certificate;
+        Certificate := NewCertificate;


Great find! I think this is a very important fix that can't wait. Maybe we should get it in separate PR as soon as possible? In case if this PR will be merged a little bit later

Drakonian · 2026-02-11T14:13:35Z

...W1/External File Storage - SharePoint Connector/App/src/ExtSharePointGraphHelper.Codeunit.al

+        Error(ErrorOccurredErr, Response.GetError());
+    end;
+
+    local procedure SplitPath(FullPath: Text; var FolderPath: Text; var ItemName: Text)


I think we can simplify this function. Instead of using ReverseString with a loop, we can simply call:

LastSlashPos := FullPath.LastIndexOf('/');

Yes indeed. Thanks

Drakonian · 2026-02-11T14:14:01Z

...W1/External File Storage - SharePoint Connector/App/src/ExtSharePointGraphHelper.Codeunit.al

+        LastSlashPos: Integer;
+    begin
+        // Find the last slash to split path
+        LastSlashPos := StrPos(ReverseString(FullPath), '/');


Could it be that FullPath has a trailing slash? In that case, I'm not sure the code will work correctly.

Mostly indeed it has a trailing slash.

Drakonian · 2026-02-11T14:23:33Z

src/Apps/W1/External File Storage - SharePoint Connector/App/src/ExtSharePointAccount.Page.al

+                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);


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

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

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

Drakonian · 2026-02-11T14:35:55Z

src/Apps/W1/External File Storage - SharePoint Connector/App/src/ExtSharePointAccount.Table.al

+            AllowInCustomizations = Never;
            DataClassification = SystemMetadata;
        }
+        field(13; "Use Graph API"; Boolean)


Should be DataClassification = SystemMetadata; ?

Correct indeed

…I usage and improve path handling in Graph Helper

Bertverbeek4PS · 2026-02-13T10:09:28Z

Added some changes of @Drakonian.
I cannot put the things on resolve because Tine created the pull request and I'm wathcing this PR because he is on holiday.

@JesperSchulz fyi

Tine Staric added 2 commits December 15, 2025 12:10

Fix parameter assignment for certificate in SetParameters method

8e7bd91

tinestaric requested a review from a team as a code owner December 15, 2025 11:12

Copilot AI review requested due to automatic review settings December 15, 2025 11:12

github-actions bot added AL: System Application AL: Apps (W1) Add-on apps for W1 From Fork Pull request is coming from a fork labels Dec 15, 2025

Copilot started reviewing on behalf of tinestaric December 15, 2025 11:12 View session

github-actions bot added the Linked Issue is linked to a Azure Boards work item label Dec 15, 2025

github-actions bot added this to the Version 28.0 milestone Dec 15, 2025

Copilot AI reviewed Dec 15, 2025

View reviewed changes

IceOnly reviewed Dec 15, 2025

View reviewed changes

JesperSchulz added the Integration GitHub request for Integration area label Dec 17, 2025

pri-kise suggested changes Dec 23, 2025

View reviewed changes

...W1/External File Storage - SharePoint Connector/App/src/ExtSharePointGraphHelper.Codeunit.al Outdated Show resolved Hide resolved

.../External File Storage - SharePoint Connector/App/src/ExtSharePointConnectorImpl.Codeunit.al Outdated Show resolved Hide resolved

Tine Staric added 4 commits December 28, 2025 11:52

Refactor SharePoint file operations to use SharePointAccount record i…

a57ebea

…nstead of AccountId

Implement file upload size handling in SharePoint Graph Helper

4c5b219

Update file upload size threshold to 4MB in SharePoint Graph Helper

24f05d8

Remove unused namespace

dfbd7e5

pri-kise suggested changes Jan 2, 2026

View reviewed changes

pri-kise mentioned this pull request Jan 7, 2026

[Bug]: Certificate-based authentication fails in Codeunit 9357 "Graph Auth. Client Credentials microsoft/ALAppExtensions#29558

Closed

1 task

JesperSchulz previously approved these changes Jan 7, 2026

View reviewed changes

JesperSchulz linked an issue Jan 7, 2026 that may be closed by this pull request

[Bug]: Certificate-based authentication fails in Codeunit 9357 "Graph Auth. Client Credentials microsoft/ALAppExtensions#29558

Closed

1 task

Add validation trigger for "Use Graph API" field in SharePoint Accoun…

10cd320

…t pages

Bertverbeek4PS dismissed JesperSchulz’s stale review via 10cd320 January 9, 2026 14:59

Aleyenda assigned JesperSchulz Jan 12, 2026

Merge branch 'main' into EFS-SharepointGraphConnector

05295dd

JesperSchulz closed this Feb 11, 2026

JesperSchulz reopened this Feb 11, 2026

Drakonian reviewed Feb 11, 2026

View reviewed changes

Enhance SharePoint Account table: add DataClassification for Graph AP…

04e3ad6

…I usage and improve path handling in Graph Helper

Comments

Conversation

tinestaric commented Dec 15, 2025 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Add Microsoft Graph API Support to SharePoint Connector

BC Idea

Problem Statement

Solution

Changes

Backward Compatibility

Dependencies

Benefits

Work Item(s)

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

tinestaric commented Dec 15, 2025

Uh oh!

IceOnly left a comment

Choose a reason for hiding this comment

Uh oh!

JesperSchulz commented Dec 15, 2025

Uh oh!

StefanSosic commented Dec 15, 2025

Uh oh!

tinestaric commented Dec 15, 2025

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JesperSchulz left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Bertverbeek4PS commented Jan 9, 2026

Uh oh!

tinestaric commented Jan 9, 2026

Uh oh!

Bertverbeek4PS commented Jan 9, 2026

Uh oh!

JesperSchulz commented Feb 11, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Bertverbeek4PS commented Feb 13, 2026

Uh oh!

Reviewers

Assignees

tinestaric commented Dec 15, 2025 •

edited by github-actions bot

Loading