How Do You Control PLC and HMI Program Versions?
Control PLC and HMI program versions by keeping an identifiable approved baseline, recording every deployed change, and verifying the running equipment against that record. Treat the PLC program and HMI application as one release package, even when only one changes. Maintenance should be able to establish what is running, why it changed, and which approved package supports recovery.
What should an approved version contain?
Make the approved baseline a complete, protected package. Give it a unique release label and keep working copies separate. Avoid names such as “latest” or “final” that leave maintenance guessing. For the approval side, see how PLC changes should be approved after commissioning.
For each machine or line, use a release record like this:
| Item | What to record |
|---|---|
| Equipment identity | Machine, controller and HMI identifiers |
| Release identity | Unique package label and approval status |
| PLC project | Exact approved project and its revision |
| HMI project | Exact approved project and its revision |
| Engineering requirements | Software versions, required libraries and relevant device versions |
| Change summary | What changed, why, and the affected functions |
| Verification | Comparison results, checks performed and unresolved limits |
| Deployment | Who deployed it, when, and to which equipment |
| Recovery | Previous approved package and restoration instructions |
Include editable projects and the deployment files required by the equipment. Record passwords and access arrangements through the plant’s controlled access process, separate from ordinary release notes.
Keep the package available to authorised maintenance staff during a breakdown. Test that another authorised person can find and open it.
How do you establish what is actually running?
Start by treating the stored project as a candidate baseline. Verify its relationship to the equipment before approving it.
Identify the physical controller and panel first. Then use the engineering environment’s supported comparison functions to compare the stored project with the running application. Check the documentation for the exact equipment: comparison coverage, upload contents and available project information vary by platform.
Record what the comparison checked and what remains uncertain. A successful connection alone should never count as proof of a match.
Where the comparison does not cover an item, verify it separately or mark it unverified. For example, establish whether the check includes hardware configuration, referenced libraries and the HMI application.
Preserve an approved baseline only after differences have been explained, reviewed and checked. If the existing machine has no reliable baseline, make that uncertainty explicit and plan a controlled reconciliation.
How should you handle binary project files?
Do not make readable text differences a condition for keeping history. Where an engineering project is stored as a binary file, retain the complete native project for each approved release.
Use a repository or controlled archive that preserves previous versions, restricts replacement of approved packages and records who added each release. Choose it around the actual project sizes and maintenance access needs.
A general version-control system can preserve binary revisions, but ordinary line-based comparison does not explain their engineering differences.
Where the engineering environment supports useful text exports, keep them alongside the native project. Use them to aid review; retain the native project as the maintained engineering deliverable.
Before accepting an exported format for recovery, verify what it preserves and prove the restoration process on suitable equipment.
What should comparison tools prove?
Define the comparison question before selecting a tool: “Does this stored release match this controller?” differs from “What changed between these two approved projects?”
For each comparison, record:
- The two versions or devices compared.
- The comparison scope and excluded items.
- The differences found.
- The reviewer’s decision on each difference.
- Any separate functional checks required.
Ask for a demonstration using representative projects before relying on a comparison product. Include a logic change, a configuration change and an HMI change in the evaluation.
Use comparison results as review evidence. Require functional checks for changed behaviour as well. For an alarm change, for example, check the condition, displayed message, acknowledgement and reset behaviour. Our guide to why operators ignore alarms explains the operating questions to resolve.
How do you control online edits?
Require the person making an online edit to leave a traceable record and reconcile the maintained project.
For planned work, agree the change, its operating conditions and its checks before connecting. Preserve the pre-change state using the platform’s supported method. After applying the edit, verify the affected behaviour and capture the resulting project.
Close the change only when the stored release and deployment record reflect the running equipment.
For urgent intervention, use a defined emergency procedure:
- Record the equipment, symptom, authorisation and intended change.
- Preserve the available pre-change state.
- Apply the change within the agreed operating limits.
- Check the affected behaviour and record the result.
- Reconcile the engineering project and obtain the required review.
Assign a named person to that reconciliation. Keep the change open until it is complete; a shift handover note alone should not close it.
Have safety-related changes assessed with a qualified assessor and follow the applicable safety change process.
How do you keep PLC and HMI releases matched?
Give each deployment a shared release label that identifies the exact PLC and HMI revisions approved together.
If only the PLC changes, name the unchanged HMI revision explicitly. If only the HMI changes, record the PLC revision against which it was checked. Avoid leaving compatibility to memory.
Before deployment, review the interface between them: tag references, command behaviour, displayed units, scaling, alarms, operating modes and access permissions. Define the intended behaviour in the functional design specification, then use it to select checks.
Illustrative example: a PLC edit changes a permissive for starting a conveyor. The HMI screens remain unchanged. The release record should identify the new PLC revision, the retained HMI revision, and the checks showing that the start command and blocked-start indication behave as intended.
A shared label identifies an approved combination. It does not require both applications to change.
What should maintenance receive after deployment?
Provide a short handover record linked to the approved package. Make these questions answerable without contacting the original programmer:
- Which release is installed on each controller and panel?
- What changed, and what checks passed?
- Are any temporary changes or unverified items still open?
- Where is the previous approved package?
- What conditions must be met before restoration?
- Who can authorise further changes?
If a release label is displayed on the HMI, verify it during handover and document how it is maintained. Use it as a reference to the release record, with equipment comparison as the stronger check.
For shutdown work, include comparison, backup, deployment checks and handover in the planned window. Our guide to planning a PLC retrofit around a shutdown window covers the wider preparation.
What common mistakes should you avoid?
Keeping backups without an approval record. Require every approved package to identify its deployment and verification status.
Overwriting the last known version. Preserve the previous approved package before introducing another.
Recording only the intended edit. Review the actual project differences and resolve unexpected changes before approval.
Leaving online edits on one laptop. Return the reconciled project to the controlled archive before closing the work.
Assuming an older program is safe to restore. Review restoration against the present machine configuration and operating state. Write down the prerequisites and required checks.
Buying a tool before defining ownership. Assign responsibility for approval, deployment and reconciliation first. Configure the tool to support those decisions.
What are the frequently asked questions?
Is a backup enough for version control?
Use backups for recovery and version records for traceability. Require each approved backup to have an identity, a change record, verification evidence and a record of where it was deployed.
Does every change need a new release?
Give every deployed program change a traceable release record, including temporary edits. For routine operator settings, define separately which values need recording and when a setting change requires engineering review.
Must PLC and HMI revision labels be identical?
They can have separate revision labels. Record the exact pair under one shared release identity so maintenance can identify the approved combination.
What if the running program has undocumented changes?
Preserve the available state and record the uncertainty. Compare it with the best available project, investigate the differences and agree the checks needed to establish a new baseline. Avoid approving it merely because production is running.
How do we start with a mixed fleet?
Start with a bounded group of machines. Inventory the equipment, establish the comparison and recovery method for each platform, and resolve baseline uncertainty. Use the same release-record structure across the fleet while retaining equipment-specific instructions.