Firewall / Infrastructure / Network communication
How does BxEngine connect to the network
This article describes the network communication used by the BxSoftware products, for use when setting up firewalls and infrastructure. All communication from BxEngine, BxSmartPrintPro and BxMobile is outgoing. No incoming ports needs to be opened in the customer's firewall.
Use DNS names when opening the firewall. IP addresses are dynamic and will change.
Contents- 1. BxEngine OnPrem
- 2. BxSmartPrintPro
- 3. BxMobile / Hand terminals
- 4. ERP integrations
- 5. BxWebManager and BxAdmin
- 6. Data communication
- 7. Freight integrations
- 8. Concept drawings
- 9. References
1. BxEngine OnPrem
BxEngine is a Windows service that runs on the main application server. The application server can be on premises or in the cloud.
BxEngine uses outgoing communication to the BxSoftware cloud services, including Azure Relay. BxEngine also connects to the ERP system, depending on the ERP system and the chosen integration. Typically it reads data from the ERP MS SQL database. Writing back to the ERP system is typically done through the ERP system's API/SDK (Visma Global VAF, Visma Business Services, web services) or in some cases custom transaction tables or files.
BxEngine always needs a connection to its own MS SQL database.
1.1 Addresses and ports
| Service | Address | Direction | Port/Protocol |
| License | license.bxsoftware.no | Outgoing | 443/HTTPS/TCP |
| BxAPI | api.bxsoftware.no | Outgoing | 443/HTTPS/TCP |
| Azure Relay | bxsoft.servicebus.windows.net + gateways, see 1.2 Azure Relay |
Outgoing | 443/HTTPS/TCP 9350-9354/TCP (recommended) |
| Software updates | partner.bxsoftware.com | Outgoing | 443/HTTPS/TCP |
| Error reporting (Sentry, optional) | o388759.ingest.sentry.io | Outgoing | 443/HTTPS/TCP |
| MS SQL | SQL Server | Outgoing | 1433/TCP (default instance) |
Error reporting is optional. If it is blocked, BxEngine works as normal, but BxSoftware will not receive error reports.
References:
Microsoft Azure Relay - https://learn.microsoft.com/en-us/azure/azure-relay/relay-port-settings
Microsoft SQL Server - https://learn.microsoft.com/en-us/sql/sql-server/install/configure-the-windows-firewall-to-allow-sql-server-access
1.2 Azure Relay
BxEngine and BxSmartPrintPro use Azure Relay (WCF relay) to receive requests from the BxSoftware cloud services without any incoming ports. The service itself opens an outgoing connection to the relay namespace bxsoft.servicebus.windows.net (Azure North Europe).
- Simplest setup: allow outgoing traffic to *.servicebus.windows.net if the firewall supports DNS wildcards (recommended by Microsoft).
- Without wildcard: allow bxsoft.servicebus.windows.net and all the gateways of the namespace: g0-prod-db3-001-sb.servicebus.windows.net to g31-prod-db3-001-sb.servicebus.windows.net, and gv0-prod-db3-001-sb.servicebus.windows.net to gv19-prod-db3-001-sb.servicebus.windows.net. This means the whole range, e.g. g0, g1, g2 ... g31 and gv0, gv1 ... gv19.
- Microsoft uses scale units and may add more gateways. An updated list can be generated with Microsoft's script GetNamespaceInfo.ps1 for the namespace bxsoft.
Ports: 443/HTTPS is required. BxEngine and BxSmartPrintPro use the relay connectivity mode AutoDetect: they use TCP ports 9350-9354 when they are open, and fall back to HTTPS on port 443 when they are blocked. Opening 9350-9354 is recommended, but not required.
References:
Microsoft Azure Relay port settings - https://learn.microsoft.com/en-us/azure/azure-relay/relay-port-settings
Microsoft Azure Relay FAQ (firewall and allowlisting) - https://learn.microsoft.com/en-us/azure/azure-relay/relay-faq
Azure Relay gateways script - https://github.com/Azure/azure-relay-dotnet/blob/master/tools/GetNamespaceInfo.ps1
Azure WCF Relay DNS support - https://docs.microsoft.com/nb-no/archive/blogs/servicebus/azure-wcf-relay-dns-support
1.3 MS SQL Server
BxEngine connects to its own database and normally to the ERP database. This is only relevant for the firewall if there is a firewall between the BxEngine server and the SQL Server. A default instance uses 1433/TCP. A named instance uses a dynamic port unless a fixed port is set, and also uses the SQL Server Browser service on 1434/UDP.
References:
Microsoft SQL Server - https://learn.microsoft.com/en-us/sql/sql-server/install/configure-the-windows-firewall-to-allow-sql-server-access
1.4 Proxy server
If outgoing internet traffic must go through a proxy server, set ProxyAddress in BxEngine.ini (BxEngine) or in the [Service] section of Server.ini (BxSmartPrintPro). These files can be found in C:\ProgramData\BxSoftware\BxEngine\Config and C:\ProgramData\BxSoftware\BxSmartPrintPro\Config
2. BxSmartPrintPro
BxSmartPrintPro is a Windows service that can run on the main application server or on a local computer in the same network as the customer's printers. BxSmartPrintPro handles printing and communication with the local Windows print queues.
BxSmartPrintPro connects to the BxSoftware cloud services through Azure Relay, and to the local print queues. Print jobs from BxEngine/BxSoftware Cloud are received through Azure Relay, so no incoming ports are needed.
| Service | Address | Direction | Port/Protocol |
| License | license.bxsoftware.no | Outgoing | 443/HTTPS/TCP |
| Azure Relay | bxsoft.servicebus.windows.net + gateways, see 1.2 Azure Relay |
Outgoing | 443/HTTPS/TCP 9350-9354/TCP (recommended) |
| Software updates | partner.bxsoftware.com | Outgoing | 443/HTTPS/TCP |
Network printers are reached from BxSmartPrintPro through the local Windows print queues.
References:
Microsoft Azure Relay - https://learn.microsoft.com/en-us/azure/azure-relay/relay-port-settings
3. BxMobile / Hand terminals
BxMobile is the client running on dedicated scanner devices, or Android/iOS mobile phones. BxMobile connects to the BxSoftware cloud services with outgoing HTTPS/443. The devices need internet access, either through the customer's Wi-Fi or a mobile network.
| Service | Address | Direction | Port/Protocol |
| BxAPI | api.bxsoftware.no | Outgoing | 443/HTTPS/TCP |
| Mobile reports | bxwm.bxsoftware.no | Outgoing | 443/HTTPS/TCP |
| App update (Android, outside app stores) | bxsoftware.no | Outgoing | 443/HTTPS/TCP |
| Error reporting (Sentry, optional) | o388759.ingest.us.sentry.io | Outgoing | 443/HTTPS/TCP |
api.bxsoftware.no is required. The other addresses are only used for reports, app updates and error reporting.
4. ERP integrations
With BxEngine OnPrem, the ERP integration runs from BxEngine on the main application server to the ERP system. The network communication depends on the ERP system and the chosen integration method (where applicable). BxEngine often uses the ERP system's own APIs, REST/SOAP/web service based APIs, SQL connections or file based integrations (local/SMB/FTP etc.).
With BxEngine Cloud, the integration runs from the BxSoftware cloud services to the ERP system's cloud API. Normally nothing needs to be installed or opened at the customer, except BxSmartPrintPro when local printers are used.
5. BxWebManager and BxAdmin
BxWebManager and BxAdmin are cloud applications hosted by BxSoftware at bxwm.bxsoftware.no and bxadmin.bxsoftware.no. All communication is in the browser and secured with HTTPS (443). The backends of both applications connect to the BxSoftware cloud API for authentication and for working with customer data.
6. Data communication
For a typical logistics customer the data is order information, including shipping address and contact information for the customer, and product information for the orders such as locations, weight and ordered quantity. Customers using features like label printing or custom reports/views often add fields such as product colour, size, customer group and/or product prices.
As part of the license validation and a high level usage overview, BxEngine also sends the license key, the number of transactions per transaction type per day, the server hostname, BIOS unique id, Windows version and .NET Framework version to BxSoftware.
BxEngine is a flexible integration engine, and the customer and consultants choose what data is read from the ERP system and sent to the devices and third party integrations.
7. Freight integrations
7.1 Consignor OnPremises
BxSoftware supports file based integration with Consignor OnPremises (COP). File communication is either local or over SMB from BxEngine or BxSmartPrintPro. When the ERP/BxEngine is installed in a different network than the Consignor server, BxSmartPrintPro acts as a communication proxy through the BxSoftware cloud API.
7.2 Web service integrations
These integrations use the freight system's web service API with outgoing HTTPS/443. With BxEngine OnPrem the connection goes from BxEngine on the application server, so the address must be allowed in the customer's firewall. With BxEngine Cloud the connection goes from the BxSoftware cloud services, and no firewall changes are needed at the customer.
| Integration | Address | Available in | Port/Protocol |
| nShift Delivery / Consignor Shipment Server | www.shipmentserver.com | BxEngine OnPrem and BxEngine Cloud | 443/HTTPS/TCP |
| Logistra Cargonizer | cargonizer.no | BxEngine OnPrem and BxEngine Cloud | 443/HTTPS/TCP |
| Axia Frakt | axiafrakt.axia.no | BxEngine OnPrem and BxEngine Cloud | 443/HTTPS/TCP |
| nShift Unifaun Online | api.unifaun.com | BxEngine OnPrem and BxEngine Cloud | 443/HTTPS/TCP |
| Shipmondo | app.shipmondo.com | BxEngine Cloud | 443/HTTPS/TCP |
| LogiSnap | newapi.logisnap.com | BxEngine Cloud | 443/HTTPS/TCP |
| Profrakt | edi.no | BxEngine Cloud | 443/HTTPS/TCP |
| SendIt | Address set in the integration setup (Url) | BxEngine Cloud | HTTPS (SOAP) |
For Profrakt and LogiSnap the address can be changed in the integration setup. The table shows the default address.
8. Concept drawings
Click a drawing to open it in full size.
8.1 C4 - level 1
8.2 C4 - level 2
9. References
- Microsoft Azure Relay port settings: https://learn.microsoft.com/en-us/azure/azure-relay/relay-port-settings
- Microsoft Azure Relay FAQ (firewall and allowlisting): https://learn.microsoft.com/en-us/azure/azure-relay/relay-faq
- Azure Relay gateways script: https://github.com/Azure/azure-relay-dotnet/blob/master/tools/GetNamespaceInfo.ps1
- Azure WCF Relay DNS support: https://docs.microsoft.com/nb-no/archive/blogs/servicebus/azure-wcf-relay-dns-support
- Microsoft SQL Server firewall: https://learn.microsoft.com/en-us/sql/sql-server/install/configure-the-windows-firewall-to-allow-sql-server-access