Skip to content

Add SFTP Connector functionality and related components #5930

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

Jump to bottom
Open
IceOnly wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Add SFTP Connector functionality and related components #5930

IceOnly wants to merge 11 commits into from

Conversation

@IceOnly
Copy link
Contributor

@IceOnly IceOnly commented Dec 23, 2025 •
edited by github-actions bot
Loading

Summary

A new SFTP connector has been added to Business Central, enabling file and folder operations through SFTP servers via the External File Storage Module. The connector supports both password and certificate-based authentication, includes comprehensive account management features with setup wizards, and provides full CRUD operations for files and directories on SFTP servers.

Work Item(s)

Fixes #5928

Fixes AB#617541

@IceOnly IceOnly requested review from a team as code owners December 23, 2025 13:10
@github-actions github-actions bot added AL: Apps (W1) Add-on apps for W1 From Fork Pull request is coming from a fork labels Dec 23, 2025
pri-kise
pri-kise suggested changes Dec 23, 2025
View reviewed changes
Copy link
Contributor

@pri-kise pri-kise left a comment

Choose a reason for hiding this comment

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

Please take a look at the documentation of the sftp client.
After any process you should disconnect the connection.

https://github.com/microsoft/BCApps/blob/main/src/System%20Application/App/SFTP%20Client/README.md#main-components

@IceOnly
Copy link
Contributor Author

IceOnly commented Dec 23, 2025

Please take a look at the documentation of the sftp client. After any process you should disconnect the connection.

https://github.com/microsoft/BCApps/blob/main/src/System%20Application/App/SFTP%20Client/README.md#main-components

Good point, I missed that. Is fixed now.

pri-kise
pri-kise suggested changes Dec 23, 2025
View reviewed changes
Copy link
Contributor

@pri-kise pri-kise left a comment

Choose a reason for hiding this comment

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

Some procedures and some variables are still named with ClientSecret instead Password

@IceOnly
Refactor authentication handling in SFTP account management to unify …
8a43784 
…password visibility and improve clarity in authentication methods
mynjj
mynjj reviewed Dec 23, 2025
View reviewed changes
src/Apps/W1/External File Storage - SFTP Connector/App/app.json
},
"contextSensitiveHelpUrl": "https://go.microsoft.com/fwlink/?linkid=2134520",
"resourceFolders": [
"data"
Copy link
Contributor

@mynjj mynjj Dec 23, 2025

Choose a reason for hiding this comment

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

in the majority of our other apps using resources, we have used .resources as a convention, I'd stick to it

Copy link
Contributor Author

@IceOnly IceOnly Dec 23, 2025

Choose a reason for hiding this comment

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

Allow other connctors have data.
A dot folder is normaly exluded from source, like .vscode, .alpackages. Makes this sense?

@IceOnly
Remove unnecessary pragma warnings in SFTP Account table procedures
753e4c5
@IceOnly
Enhance SFTP account table with port validation and update SFTP conne…
7ec63cc 
…ctor implementation for improved path handling; add comprehensive test documentation for better coverage and clarity.
@IceOnly
Refactor SFTP account handling to unify password and certificate mana…
53b900c 
…gement; update procedures to use Text type for certificates and enhance account creation logic.
@JesperSchulz JesperSchulz added Integration GitHub request for Integration area Linked Issue is linked to a Azure Boards work item labels Jan 6, 2026
@github-actions github-actions bot added this to the Version 28.0 milestone Jan 7, 2026
JesperSchulz
JesperSchulz reviewed Jan 7, 2026
View reviewed changes
JesperSchulz
JesperSchulz requested changes Jan 7, 2026
View reviewed changes
Copy link
Contributor

@JesperSchulz JesperSchulz left a comment

Choose a reason for hiding this comment

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

Still a bit of work to do before we can merge, but you're getting there! Fast 💨💨💨

JesperSchulz
JesperSchulz previously approved these changes Jan 8, 2026
View reviewed changes
stkillen
stkillen previously approved these changes Jan 8, 2026
View reviewed changes
Copy link
Contributor

@stkillen stkillen left a comment

Choose a reason for hiding this comment

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

Overall, looks good.

I left a couple of comments.

Additionally, what is connector-logo.png? Where is this from?

@IceOnly IceOnly dismissed stale reviews from stkillen and JesperSchulz via 363cb4c January 8, 2026 16:51
@IceOnly
Copy link
Contributor Author

IceOnly commented Jan 8, 2026

Overall, looks good.

I left a couple of comments.

Additionally, what is connector-logo.png? Where is this from?

connector-logo.png is the logo shown in the file accounts lists.
It is the logo of the SSH.NET component (https://github.com/sshnet/SSH.NET), used by the new SFTP Module in the system app (

BCApps/src/System Application/App/DotNet Aliases/src/dotnet.al

Line 2224 in c3583d2

assembly("Renci.SshNet")
).

JesperSchulz
JesperSchulz approved these changes Jan 9, 2026
View reviewed changes
Copy link
Contributor

@JesperSchulz JesperSchulz left a comment

Choose a reason for hiding this comment

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

I'm happy now :-) Approved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mynjj mynjj mynjj left review comments

@JesperSchulz JesperSchulz JesperSchulz approved these changes

@stkillen stkillen stkillen left review comments

+1 more reviewer

@pri-kise pri-kise pri-kise requested changes

Reviewers whose approvals may not affect merge requirements

At least 2 approving reviews are required to merge this pull request.

Assignees

No one assigned

Labels

AL: Apps (W1) Add-on apps for W1 From Fork Pull request is coming from a fork Integration GitHub request for Integration area Linked Issue is linked to a Azure Boards work item

Projects

None yet

Milestone

Version 28.0

Development

Successfully merging this pull request may close these issues.

[BC Idea]: External File Account: Add SFTP Connector

5 participants

@IceOnly @JesperSchulz @pri-kise @mynjj @stkillen