The Sproom Service Settings page enables the Sproom FTP Integration in Electronic Invoicing with Sproom to connect Business Central with the Sproom FTP server, holding the folder path, authentication credentials, and optional SSH private key that authorize and direct the file upload. Sproom Service Settings is where all FTP connection details are entered, tested, and maintained.
Feature Overview
Sproom Service Settings for the FTP integration brings together all connection details needed to deposit OIOUBL documents on the Sproom FTP server. When Integration Type is set to Export to FTP, the page shows the Folder Path where XML files are uploaded, and the User Name and User Password fields for password-based authentication. For companies using SSH key authentication, the Private Key Exists indicator shows whether a key is currently loaded, and the Import Private Key, Export Private Key, and Delete Private Key actions manage the .ppk key file stored inside Business Central. The Test Connection action verifies that the folder path, credentials, and key are accepted by the FTP server before any invoices are sent.
Typical Use Cases / User Stories
- A consultant configuring Sproom for a new company enters the Folder Path and User Name on Sproom Service Settings, uses Import Private Key to upload the .ppk file provided by Sproom, and runs Test Connection to confirm the server accepts the credentials before going live.
- As an IT administrator, I want to replace an expiring SSH private key without interrupting live invoicing — I use Delete Private Key to remove the old key, Import Private Key to load the replacement, and Test Connection to verify the new key works.
- A company migrating Business Central to a new environment uses Export Private Key to extract the .ppk file from the old environment and Import Private Key to load it in the new one, preserving the FTP connection without requesting a new key from Sproom.
- An accounts receivable manager suspects the FTP connection broke after a server change at Sproom — she runs Test Connection on Sproom Service Settings to diagnose whether the issue is with the credentials or the server, before contacting support.
- A company switching from password-based FTP authentication to SSH key authentication removes the User Password, uses Import Private Key to upload the .ppk file, and confirms the new setup with Test Connection.
Key Concepts
- Folder Path: The full path to the directory on the Sproom FTP server where Business Central deposits XML files. A trailing slash is added automatically if omitted.
- Private Key Exists: A read-only indicator that shows whether an SSH private key (.ppk) is currently stored in Business Central. When a key is present, it is used for SFTP authentication in preference to the password.
- Import Private Key: Uploads a .ppk SSH private key file and stores it securely inside Business Central. Used when the Sproom FTP server requires key-based authentication.
- Export Private Key: Downloads the currently stored .ppk file from Business Central. Used when migrating the key to a new environment or taking a backup.
- Delete Private Key: Removes the stored SSH private key. After deletion, the FTP connection falls back to username and password authentication.
Relations to Other Features or Apps
- Sproom Service Settings for FTP is part of the broader Sproom FTP Integration. Once the FTP connection is configured here, Business Central deposits OIOUBL files on the server automatically when invoices are sent.
- The same Sproom Service Settings page is also used for the REST API integration — see Sproom Service Settings (API) for API-specific configuration including the Token Value and Status Polling Interval (Min).
- In addition to FTP connection settings, the page provides access to optional document-enrichment features — Enable Attachments, Include Invoice as PDF, Payment Means, and Add Comment Lines — which apply regardless of the active integration method and are each documented separately.
Frequently Asked Questions
What format does the private key need to be in for the Sproom FTP integration?
The Sproom FTP integration uses .ppk (PuTTY Private Key) format for SSH authentication. Use the Import Private Key action on Sproom Service Settings to upload the .ppk file provided by Sproom. If your key is in OpenSSH or another format, convert it to .ppk using a tool such as PuTTYgen before importing.
What should I check if Test Connection fails for the FTP integration?
A failed Test Connection typically means the Folder Path, User Name, User Password, or private key does not match what the Sproom FTP server expects. Verify that the Folder Path points to the correct directory, confirm the credentials with Sproom, and check that the Private Key Exists indicator reflects whether a key should be present. Contact Sproom support if the settings appear correct but the connection still fails.
If I have both a password and a private key configured, which one does Business Central use?
When a private key is stored in Business Central — as shown by the Private Key Exists indicator — it is used for SFTP authentication in preference to the password. You do not need both simultaneously; use whichever method your Sproom FTP server requires. To switch back to password authentication, use Delete Private Key to remove the stored key.
When This Feature Adds Value
- You are setting up the Sproom FTP integration for the first time and need to enter and verify the server credentials before going live.
- You are migrating Business Central to a new environment and need to transfer the stored private key to preserve the FTP connection without re-requesting it from Sproom.
- The FTP credentials or private key have changed and need to be updated in Business Central before invoicing can resume.
- You want to verify that the FTP connection is still working after a network or server change, without sending a live invoice to test it.