Install On-Premises
This guide covers installing the SharePoint Connector in Business Central on-premises environments. On-premises installation requires manual deployment of the app package.
Before You Begin
Prerequisites
| Requirement | Description |
|---|---|
| BC Admin Access | Server administrator permissions |
| BC Version Known | Verify you run Business Central 24 (2024 release wave 1) or later |
| App Package | Download the app package |
| PowerShell Access | Access to Business Central Administration Shell |
| Outbound Internet | For SharePoint Online connectivity |
Version Compatibility
The app declares a minimum platform version of 17.0.0.0 but uses AL runtime 13.0 (app.json), which requires Business Central 24 (2024 release wave 1) or later. A single package is produced; the publisher does not produce separate per-version packages. If you need a build targeting a specific platform, contact the publisher.
Obtaining the App Package
Download Process
- Contact the publisher (hougaard.com) via https://www.hougaard.com/sharepoint/
- Receive the
.apppackage file (a single package supports all compatible BC versions) - Save the file to a location accessible from your BC server
Package Contents
The app package is a single .app file containing:
- Extension code
- Metadata
- Resources
Installation Steps
Step 1: Prepare the Server
- Log into your Business Central server
- Open Business Central Administration Shell (as Administrator)
- Verify the BC service is running
Get-NAVServerInstance
Step 2: Publish the Extension
Publish makes the app available but doesn't install it:
Publish-NAVApp -ServerInstance "BC210" -Path "C:\Apps\SharePointConnector.app" -SkipVerification
Replace:
BC210with your server instance name- Path with your actual file location
Step 3: Sync the Extension
Synchronize the extension schema with the database:
Sync-NAVApp -ServerInstance "BC210" -Name "SharePoint Connector" -Version "6.0.0.4109"
Step 4: Install the Extension
Install the extension for specific tenants/companies:
Install-NAVApp -ServerInstance "BC210" -Name "SharePoint Connector" -Version "6.0.0.4109"
For multi-tenant environments, specify the tenant:
Install-NAVApp -ServerInstance "BC210" -Name "SharePoint Connector" -Version "6.0.0.4109" -Tenant "default"
Step 5: Verify Installation
Verify the extension is installed:
Get-NAVAppInfo -ServerInstance "BC210" -Name "SharePoint Connector"
Or check in Business Central:
- Open Business Central
- Go to Extension Management
- Verify SharePoint Connector appears with "Installed" status
Multi-Company Installation
Installing for All Companies
To install for all companies in a tenant:
Get-NAVCompany -ServerInstance "BC210" | ForEach-Object {
Install-NAVApp -ServerInstance "BC210" -Name "SharePoint Connector" -Version "6.0.0.4109" -CompanyName $_.CompanyName
}
Installing for Specific Companies
To install for specific companies only:
Install-NAVApp -ServerInstance "BC210" -Name "SharePoint Connector" -Version "6.0.0.4109" -CompanyName "CRONUS USA, Inc."
Updating the Extension
Update Process
When a new version is available:
- Obtain the new app package
- Publish the new version
- Sync the new version
- Upgrade to the new version
# Publish new version
Publish-NAVApp -ServerInstance "BC210" -Path "C:\Apps\SharePointConnector_v2.app" -SkipVerification
# Sync new version
Sync-NAVApp -ServerInstance "BC210" -Name "SharePoint Connector" -Version "6.0.0.4109"
# Start upgrade
Start-NAVAppDataUpgrade -ServerInstance "BC210" -Name "SharePoint Connector" -Version "6.0.0.4109"
Post-Update Steps
After updating:
- Verify the new version is active
- Test key functionality
- Review any new settings or features
Uninstalling the Extension
Uninstall Process
To remove the extension:
# Uninstall from companies
Uninstall-NAVApp -ServerInstance "BC210" -Name "SharePoint Connector" -Version "6.0.0.4109"
# Unpublish
Unpublish-NAVApp -ServerInstance "BC210" -Name "SharePoint Connector" -Version "6.0.0.4109"
Data Retention
When uninstalling:
- Configuration data may be retained in the database
- SharePoint documents are not affected
- Consider backing up settings before uninstalling
Troubleshooting Installation
Common Issues
| Issue | Cause | Solution |
|---|---|---|
| Publish fails | Version mismatch | Use correct package for BC version |
| Sync fails | Schema conflicts | Check for conflicting extensions |
| Install fails | Permission or config issue | Verify server instance and permissions |
| App not visible | Not installed in company | Run Install-NAVApp for each company |
Checking Extension Info
View extension details (note: the SharePoint Connector has no external dependencies):
Get-NAVAppInfo -ServerInstance "BC210" -Name "SharePoint Connector"
Viewing Installation Errors
Check the event log for detailed error information:
- Open Event Viewer
- Navigate to Application and Services Logs > Microsoft > DynamicsNAV
- Review Server and Admin logs
Network Configuration
Required Endpoints
Ensure outbound access to:
| Endpoint | Port | Purpose |
|---|---|---|
*.sharepoint.com |
443 | SharePoint REST API |
login.microsoftonline.com |
443 | OAuth (Public cloud) |
login.microsoftonline.us |
443 | OAuth (US Government cloud) |
check.hougaardlicense.com |
443 | License validation (production activation only) |
*.cognitiveservices.azure.com |
443 | OCR via Azure Computer Vision (the endpoint configured in OCR Service URL; only required when OCR is used) |
www.efoqus.ca |
443 | Legacy registration code (still contacted) |
Firewall Rules
Add firewall rules to allow outbound HTTPS (443) to Microsoft 365 endpoints.
Proxy Considerations
If using a proxy:
- Configure BC server to use the proxy
- Ensure proxy allows Microsoft 365 traffic
Post-Installation
After successful installation: