IMDTouchKnowledge BaseShop main store

Troubleshooting

Verify HMI project data is inside your platform backup

HMI and touchscreens Published 7 min read

Short answer

A backup is proven at restore, not at completion. Platform archives such as the ctrlX appData scope have returned configuration while omitting HMI application projects — WebIQ data sat outside that scope until WebIQ 2.16 added save and restore on core22. Record the project inventory, restore into an isolated target, and count the projects that come back: that count, not the completion message, tells you the machine is recoverable.

On this page
  1. Why a completed backup can still lose the projects
  2. Separate a missing project from a dead value
  3. Run the restore test on an isolated target
  4. What has to match on the platform
  5. Why a file copy is not a workaround
  6. The decision for each case
  7. Questions asked

A backup is not a backup until a restore brings the project back. A platform archive — on ctrlX, the appData manager's active-configuration scope — can complete and store cleanly while never containing the HMI application's project data. That failure is recorded for WebIQ: earlier integrations kept the project data outside appData, a restore returned the platform configuration with the projects gone, and the fix arrived as WebIQ 2.16, which supports backup and restore when ctrlX runs with core22. The decision procedure is one step long: record the project inventory, restore the archive into an isolated target, and compare the two lists. Projects missing means the backup scope excludes them and the machine is not recoverable from that archive — fix the coverage before you commission anything from a restore or a card.

Why a completed backup can still lose the projects #

This is a different fault from an export that never happened or a project that refuses to open: the export path can work perfectly, and the backup tool is what silently drops the data. An archive can only return what entered it. The appData manager captures the platform's active configuration; application data reaches the archive only when the application itself participates in the platform's backup lifecycle. When it does not, nothing errors — the archive validates, stores and completes, and the missing data never existed inside it.

That is what happened with WebIQ on ctrlX. The vendor's answer named the cause — WebIQ data was not stored in appData — and explained that the fix took more than moving a storage path, because an application has to expose its persistent data to the backup lifecycle and restore it into a usable state. The supported capability is WebIQ 2.16 on ctrlX running core22. Generalize from that: application persistence is a contract between the application and the backup manager, and it is version specific.

IEC 62443-3-3 puts the intent in standard language with SR 7.3: the control system shall provide the capability to back up critical configuration and software and to restore from that backup. An archive that returns configuration but not the application's projects does not restore the control system, whatever the completion log says.

Set the standard of proof before anything else: a completion message certifies the archive file, never the machine. Only a restore certifies the machine.

Separate a missing project from a dead value #

A restored screen that misbehaves has four distinct causes, and only the first is a backup fault.

What you see after the restore Where the fault lives What it means
The project is gone from the project list Application persistence The archive scope omitted the project data. Fix the backup, not the panel.
The project opens, screens load, values stay dead Tag bindings, driver, controller link The restore worked. Debug communication and controller data separately.
A different or older project revision came back Archive identity The archive holds another revision. Label every archive with its project revision and versions.
The runtime itself will not start Software provisioning Restoring data is not installing software. Card-based commissioning needs the application present and compatible too.

No change of PLC address, driver or tag binding recovers data that never entered the archive, so start row one from the backup side, not the screens. Screens are not the only data in that class: trends and alarm histories persist outside the compiled project too, and verifying HMI historical trend retention before committing is the same style of check — prove the store survives a restore before you promise the history.

Run the restore test on an isolated target #

The test is short, and it settles the question:

  1. Record the starting state. List the projects from the runtime's project inventory, note each project's size where the runtime reports one, and read the runtime and platform versions from the installed device and application information — not from a checklist or an archive filename.
  2. Bring the application to a consistent state: finish and save project edits and follow the vendor's documented preparation before archiving.
  3. Create the archive with the supported workflow. On ctrlX, backup and restore are activities you load onto the device for execution from the Device Portal.
  4. Restore into a target that cannot move the machine — a spare unit on the bench — or hold the real machine in a safe state, because a restore can restart runtimes and drive outputs.
  5. Count what came back: compare the restored project list against the recorded inventory, project by project, and reconcile the reported sizes.
  6. Decide by the count, not by the restore's completion status.

Worked example: the arithmetic that catches the gap #

The figures below are an illustrative example, not a measured result; substitute your own inventory.

Suppose the pre-backup inventory lists six projects with reported sizes of 38, 61, 12, 9, 47 and 24 MB. The persistent project data totals 38 + 61 + 12 + 9 + 47 + 24 = 191 MB. The archive completes. A bench restore brings back the platform configuration — network, users, application settings — and the project inventory lists zero of six. The archive is intact and the machine is not recoverable: those 191 MB never entered its scope. That is the pre-2.16 WebIQ situation in miniature.

Repair it in the right order. Move to the supported combination, WebIQ 2.16 on ctrlX with core22, and build a new archive from an installation that still holds the projects — an archive created before the fix cannot retroactively include the data it omitted. Restore again on the bench: six of six projects return and the sizes reconcile, 38 + 61 + 12 + 9 + 47 + 24 = 191 MB. That second count is what makes commissioning a machine from a memory card without a PC a proven process rather than a hope.

What has to match on the platform #

The supported combination is WebIQ 2.16 with ctrlX running core22. Read the application version from the installed application information and the platform base from the device information. The presence of a backup manager does not grant an older combination the capability; the versions decide.

The workflow lives in the ctrlX Device Portal, where you load activities — software updates, backups, restores — onto the device for execution.

Every other platform answers to the same test with the same decision: if your installed combination is not a named, supported save-and-restore combination, treat every archive as configuration-only until a bench restore proves otherwise. Locating the vendor's own documentation is part of that proof, and for an older runtime it is often the hard part — the same hunt as tracking down manuals for a legacy HMI software package.

Why a file copy is not a workaround #

For the WebIQ-on-ctrlX integration behind this case, the vendor ruled a workaround out: copying the files somewhere else did not put them inside the appData scope, because persistence is more than a path. A copying flow has to decide when writes stop, which files belong together and when the runtime may restart, and a copy taken mid-write can hold mismatched files that look complete.

A folder copy is a candidate archive, nothing more. It passes or fails by the same bench restore and the same count as any archive produced with the supported workflow.

The decision for each case #

  • Restore returns every recorded project — the archive is validated. Re-run the test whenever the project revision, the runtime version or the platform base changes, because each can silently move the scope.
  • Configuration returns and the projects do not — the scope excludes the application data. Move to the supported save-and-restore combination, build a new archive from an installation that still holds the projects, and repeat the bench restore. Do not commission from the failed archive, and do not try to repair it after the fact.
  • Projects missing and no copy anywhere — that archive cannot recover them. What remains is pulling whatever exists off the device, and recovering an HMI program when the source file is lost is the honest map of what that route can and cannot return.
  • Only an untested file copy exists — run the same bench restore before it counts as a backup.
  • The controller is a separate archive with its own scope, and the HMI archive never carries the PLC program: back up a PLC program the right way as its own exercise.

Questions asked

Why can't I just download the project back off the HMI after a bad restore?

Because most panel platforms keep the compiled runtime on the device, not the editable source. Siemens panels cannot upload source code into TIA Portal, for example; only compiled runtime files exist on the unit. When the archive omitted the project and no engineering copy exists, you are into recovery, not download, and recovery may hand back screens you cannot edit. The restore test exists so you learn this on a bench unit instead of at the machine.

How often should the restore test be repeated?

Repeat it whenever anything in the chain changes: a new project revision deployed, a runtime upgrade, a platform base update or a change of backup tool, because each can silently alter what the archive scope includes. Between changes, a fixed cadence such as once per quarter keeps drift visible. Always re-test the full chain — archive, restore, project count — since a clean backup run alone proves nothing about what the archive contains.

A file copy of the project folders passed a restore test once. Can I keep using it?

Yes, with the same discipline as any archive: retake it only from a consistent application state, label it with the project revision and the runtime and platform versions, and re-run the restore test after every revision or version change. What you cannot do is build commissioning on a copy that has never been restored. Untested, it is an assumption, not a backup.

Keep reading

  • How-to

    How to verify the HMI project version running on a panel

    A panel does not expose a build signature you can read back, so make the project carry its own: a release label on a maintenance screen, an approved archive, and a deployment-record entry per panel. Read the label on every panel and compare it with the record; a checksum of runtime files is a different check over different bytes, and neither value substitutes for a safety signature.

    HMI and touchscreens

  • Troubleshooting

    When an HMI project fails to open: recovery and backup

    A Vijeo Designer project that no longer opens is recovered from the editor's local project storage on the PC, not from the panel. Save never creates a portable backup: close the project in the manager, export it and keep that export as a zip after every working session, then prove the zip by importing it into a clean editor and building.

    HMI and touchscreens

  • Troubleshooting

    Fixing an HMI Project That Fails After a Git Clone

    The clone is broken because a referenced bitmap .PLK was never committed, not because of an ignore rule. Read the HMI Output tab for the exact filename, prove the file is untracked with git check-ignore followed by git ls-files, then restore and commit it and re-test from a clean clone. Track the .tgt and .def files for the HMI BIOS version as well.

    HMI and touchscreens