Software Upgrade Center
Software Upgrade Center manages Banalytics core and module updates through the portal, downloads selected packages, stages them locally, and starts the platform-specific upgrade job.
Connect upgrades to the portal-managed module set
The Portal Software Upgrade Center is responsible for managing and applying software updates on the local Banalytics server. It connects the server to the Banalytics upgrade service, reads installed modules, compares them with the versions selected in the portal, and prepares the local upgrade folders.
Use it when updates should be controlled from the portal rather than copied manually to the device. The upgrade process is designed to update Banalytics software without changing user settings or stored video data, but it still requires a restart window and reliable access to the operating system for recovery.
Keep Portal Integration online
The server must be connected to the portal and the environment must have a registered identifier. Without this connection the upgrade request is cancelled.
Select target module versions
Choose the required core, module, dependency, and model versions in the portal. Optional feature modules can be installed by selecting a version or removed by selecting the not-installed state.
Start during a maintenance window
The component downloads files first, then starts the upgrade job. Plan for temporary disconnection while Banalytics restarts and reloads modules.
Configuration parameters
| Parameter | Required | Description | Default |
|---|---|---|---|
ID | Yes | A unique, fixed identifier for this system component instance. This value is generated by the platform and is not editable. | Auto |
Restart on failure | Yes | Restart mode after an error:
| 10 sec |
Software update type | Yes | Defines how the server applies portal-selected updates:
| Manual software upgrade |
Stage, verify, and apply module changes
Software Upgrade Center communicates with Portal Integration, reads the currently installed module set, requests the target module set from the portal, downloads module jars, dependency packages, and model packages, then stages the result in local upgrade folders.
After the download succeeds, the upgrade job swaps staged modules into the active module folder during restart. If the first-run module information is missing, the component treats the device as a fresh installation and synchronizes it with the portal-defined module set.
Portal-controlled versions
The portal is the source of truth for the target core and module versions assigned to the environment.
Local staging
Downloads are cached, staged, and backed up locally before the active module set is replaced.
Restart boundary
Module changes become active after the upgrade job and application restart complete successfully.
Choose the right upgrade workflow
Normal production installation
Keep Software update type set to Manual software upgrade. This is the safest default because upgrades are applied only after the user changes module versions in the portal or starts the upgrade manually. Use this mode for cameras, recording, alarm, or access-control systems where an unexpected restart would interrupt active work.
Controlled maintenance window
Use Manual software upgrade, choose the required module versions in the portal, and start the upgrade when the device can be restarted. Plan for temporary disconnection while Banalytics restarts and reloads modules.
First installation or fresh provisioning
When module information is missing, the component automatically treats the device as a first run and initiates software synchronization. This helps bring a new device to the module set assigned in the portal without manual file copying.
Kiosk or unattended device
Use Software upgrade on boot when the server is expected to check and apply the portal-defined module set every time Banalytics starts. This fits centrally managed fleets, but only when the device has reliable network access and an alternative recovery path.
Test or staging channel
Select staging or older versions in the portal, then start the upgrade from Software Upgrade Center. Use a non-critical device for staging modules because module changes can affect startup, task behavior, native libraries, and model compatibility.
Module rollback
Select an earlier module version in the portal and apply the upgrade in Manual software upgrade mode. The mechanism is the same as a forward update: selected versions are downloaded into the staged upgrade folder and installed after restart.
Add or remove feature modules
Install optional modules by selecting a version in the portal, or remove them by selecting the not-installed state. Review dependent tasks before removing a module because tasks from that module will no longer be available after restart.
Operational notes
Portal registration is required
Portal Integration must be connected and the environment must have a registered identifier. If the environment is not registered, the upgrade is cancelled.
Local upgrade folders
The component uses modules-download as a cache, modules-upgrade as the staged installation folder, modules-backup for the previous module set, and models for downloaded model packages.
One synchronization at a time
Only one synchronization is processed at a time. A second request is skipped while an upgrade is already in progress.
Successful download marker
A successful download writes modules-info.properties into the staged upgrade folder. Startup or the upgrade job then swaps the staged modules into the active modules folder.
Platform-specific restart behavior
On Windows the upgrade is started through upgrade-job-start.bat. On Linux the agent requests a reboot after staging the modules. Make sure the service manager or deployment environment starts Banalytics again after the process exits.
Disk space matters
Keep enough disk space for active modules, staged modules, downloaded dependency archives, model packages, and the temporary backup. Lack of disk space can leave the device waiting for manual cleanup or rollback.
Avoid critical windows
Do not start upgrades during critical recording or automation windows unless downtime is acceptable. If an update is interrupted, recovery or retry behavior depends on the component lifecycle and service restart configuration.
Keep out-of-band access
For remote installations, keep an alternative access path to the operating system. If a module upgrade prevents startup, manual access may be required to inspect logs, restore modules-backup, clean modules-upgrade, or restart the service.