BCCL
Business Central Command Line
Installation Guide
The installation of BCCL is two-part. An extension that goes into Business Central and a command-line executable file.
Cloud Business Central
Upload the .app file from the extension folder to your BC from Extension Management.
On-premises Business Central
Use the PowerShell Publish-NAVApp to publish the extension. https://docs.microsoft.com/powershell/module/microsoft.dynamics.nav.apps.management/publish-navapp
Use the -install parameter to also install the extension after publish.
Docker-based Business Central
Use Publish-BcContainerApp from BCContainerHelper to publish the extension into a BC running in a Docker container.
Use the -install parameter to also install the extension after publish.
Client installation
There’s no installation for the client. The client is a single executable file, use your favorite copy command to copy the executable to “a good place”.
The client support Windows, macOS and Linux, all 64bit.
(Don’t be alarmed over the file size of the client executables, they are around 80 MB to be completely self-contained without any external dependencies).
Running BCCL in trial mode
Register your BCCL
Before BCCL can be used on full data loads, you must register the app, this is also done through the command-line. You’ll receive a Key that must be registered with this command:
BCCL --register (the key you received) --tenantid (your BC tenant ID (guid))If the key is correct, you’ll receive a reply like this:
Registration completed, key is valid.Connecting for the first time
From Business Central you can also run BCCL Request Builder (Alt-Q and search for BCCL) to get the first commands and the Request Builder Tool that can help you figure out what parameters to use and combine.
When BCCL is not returning data, all replies are returned as json to easier process the replies automatically.
The URL for BCCL can be found in Business Central under Web Services. Locate the bccl web service and copy the Soap URL to your command-line:
If you’re using a cloud instance of BC you have to use OAuth authentication (–auth)
Installation and running BCCL as a service (On Windows Server)
If you want to use BCCL in Service Task mode, then you need BCCL installed as a service (it will run in a console for testing)
Copy BCCL.EXE to an empty folder and copy the bccl-install-service.cmd and bccl_service.example_s2s_auth files from the BCCL installation ZIP to the same folder.
Make sure you have a working Entra App registration created (See video above)
Now rename the bccl_service.example file to bccl_service.json and edit the fields so they match your Business Central
{
"agentid": "MY_BCCL",
"auth": "S2S",
"clientid": "xxxxxxxxxxx",
"tenantid": "xxxxxxxxxxxxxxxxxx",
"clientsecret": "xxxxxxxxxxxxx",
"url": "https://api.businesscentral.dynamics.com/v2.0/c1f19d2f-252e-4d89-a7c7-5bb9042d59eb/dev27/WS/CRONUS%20Canada%2C%20Inc./Codeunit/bccl",
"defaultcompany": "CRONUS Canada, Inc.",
"verbose": "true"
}
BCCL 3.23.0.344+2025-09-13
info: Microsoft.Hosting.Lifetime[0]
Application started. Press Ctrl+C to shut down.
info: Microsoft.Hosting.Lifetime[0]
Hosting environment: Production
info: Microsoft.Hosting.Lifetime[0]
Content root path: C:\installedApps\BCCLasService
Now Service Agent should show up in Business Central:
You can stop BCCL in the console with Ctrl-C.
To install BCCL as a service, edit the bccl-install-service.cmd to reflect the folder where you have installed BCCL.
Run bccl-install-service.cmd and then go to Service Management to change Log On As to a user that has permissions to resources that BCCL need permissions to.
Upgrade from BCCL 2.x to BCCL 3.0
The BCCL 3.0 App in Business Central requires the BCCL 3.0 client (the exe file). The 3.0 client can work with the 2.0 app.
So the best approach to avoid interruptions is a two-step plan:
- Upgrade the client EXE from 2.0 to 3.0
- Upgrade the BC app from the “268” version to version 3.0