Book a consultation

octoplant Version Control and Change Management: The Approved-Version Model

octoplant Check In Check Out: The Edit Cycle and Who Can Do What

octoplant check in check out explained: the edit cycle in the native tool, what it asks of engineers and contractors, and what bypassing it costs.

Vladimir Romanov


octoplant check in check out is the planned-change path in AMDT’s version control: an engineer takes the approved version out of the repository, edits it in the vendor’s own engineering tool, and puts a new version back with an explanation. AMDT describes it in one sentence: teams “check out the latest approved version, make changes in their familiar engineering tools, then create and check in a new version” (AMDT, About octoplant).

The question this page answers is practical: what does that cycle look like on a working day, what does it demand of the people doing it, and what happens when somebody does not follow it. For the model behind it, read the parent page on octoplant version control and change management.

The octoplant check in check out cycle, step by step

The octoplant check in check out cycle and the online-edit bypass Five steps in a row: approved version in the repository, check out a working copy, edit and test in the native tool, check in with a comment, approve as the new reference. An arrow returns from approval to the approved version. From the edit step, a download goes to the running device. Below, an online edit from a laptop goes straight into the running device, bypassing the cycle, and change detection finds it on the next job. The planned path, and the shortcut around it the new version becomes the reference; the old one stays in history Approved version in repository Check out working copy Edit and test in native tool Check in with comment Approve new reference download at the machine Running device what actually runs Online edit bypasses the cycle Change detection finds it on the next job
Check-in and check-out govern the planned path. The online edit never touches the repository, which is why change detection exists alongside it.

A typical planned change, as the cycle is described publicly. The detail of each screen depends on the octoplant release and the device type.

  1. Check out the approved version. The engineer takes the current reference for the device from the repository. Starting here, not from a copy on a laptop, is the whole point.
  2. Open it in the native tool. Studio 5000, TIA Portal, an HMI editor or a robot program editor. octoplant does not edit logic itself; the engineer needs the right licensed version of that software.
  3. Make and test the change. Offline, then at the machine during the agreed window, with a download to the device.
  4. Check in a new version with a comment. The comment says what changed and why: the work order, the problem, the expected effect.
  5. Approve, if the workflow requires it. AMDT describes “configurable approval workflows” that provide “a controlled path from modification to approved version,” with the approval becoming part of the traceable history (AMDT, change management and version control).
  6. Verify. The next scheduled job uploads from the device and confirms the running program matches the new approved version. A step-by-step look at that comparison is on the Smart Compare page.

An illustrative scenario. A controls engineer adds a new SKU to a palletizer recipe table. She checks out Monday’s approved version, adds the recipe in the native tool, downloads it during Tuesday’s changeover and runs ten pallets. She checks in with the work order number and “added SKU 4471 pattern, layers 1 to 6.” The area lead opens the compare, sees only the recipe table changed, and approves. Six months later, when a pallet pattern fails, the history answers in a minute what used to take an afternoon of guessing.

What octoplant check in check out requires of people

Close-up of hands turning a graduated dial on a machine tool slide to set a precise position
Check-out and check-in only work when every edit is made as deliberately as a setting on a dial: started from a known position, recorded, and reversible.

Engineers must start every change from a check-out, keep their native tools at versions the plant supports, and write comments someone else can read in two years. The hard part is the first one, because opening the copy already on the laptop is always quicker.

Contractors and integrators need access to the plant’s repository, or a defined way to hand in versions at milestones. That belongs in the contract. Our guide to working with system integrators explains why the handover terms matter as much as the price. If the integrator works remotely, agree how they check out without a direct connection to every device.

OEM machine builders often deliver a machine with its own program and keep servicing it. Agree who owns the approved version after acceptance, whether the OEM checks in its service changes, and what happens to its warranty if the plant edits the logic.

Approvers need time in the day to approve. An approval queue that waits a week teaches people to go around it.

When someone bypasses it: online edits

Online edits are normal in plants. A breakdown at two in the morning will be fixed at the controller, not through a check-out, and no software changes that. octoplant cannot block an online edit. Preventing one is the job of controller security settings, network access and procedure, and our OT network assessment is where that layer is usually examined.

What the system does is make the bypass visible. AMDT states that octoplant detects “planned, accidental, or unauthorized changes” and runs scheduled jobs that compare the device against the approved version (AMDT, About octoplant). The change detection page covers how those jobs work and how to triage what they find.

The rule that keeps the two worlds aligned: every online edit is followed, within an agreed time, by an upload, a check-in with a comment and, where required, an approval. Otherwise the repository drifts away from the plant and the next planned change starts from the wrong version.

Comment and approval discipline

A version history is only as useful as its comments. “Updated” tells an auditor nothing. NIST’s OT security guide asks for exactly this: document, test and approve changes before they are deployed, and keep the approved baseline documented (NIST SP 800-82 Rev. 3, section 6.2.4.2). The comment and the approval are where that record lives.

  • Name the reason. Work order, deviation or problem, in a consistent format.
  • Name the effect. “Raised jam timer on infeed conveyor from 2 s to 3 s” is checkable.
  • Separate the approver from the author. One person should not approve their own change into the reference.
  • Approve against a compare, not a comment. The approver should look at what actually changed.
  • Match approval to risk. Mandatory release for safety, quality-critical or validated systems; check-in with comment for low-risk changes.

An illustrative roles and permissions table

AMDT says octoplant provides “role-based access to control who can modify, approve, or restore configurations” (octoplant.com, versioning). Its role names and the edition in which each permission appears are not public. The table is a starting design for a plant to adapt, not AMDT’s configuration.

ActionEngineerApproverTechnicianContractor / OEMAuditor
View versions and historyYesYesYesOwn scopeYes
Check outYesYesNoOwn scopeNo
Check in with commentYesYesNoOwn scopeNo
Approve a new referenceNoYesNoNoNo
Restore a known-good versionYesYesYes, with recordNoNo
Configure jobs and alertsAdmin onlyAdmin onlyNoNoNo

Where it gets hard

  • Concurrent work. AMDT’s public pages do not say whether a check-out locks the project or how two engineers’ changes are reconciled. Shutdowns with several engineers on one line test this.
  • Native tool versions. The cycle depends on every engineer having the right version of the native tool. A project saved in a newer version can stop others opening it; the Studio 5000 project structure page shows why this bites Rockwell sites in particular.
  • Remote and offline work. Engineers at an OEM’s office or a site without a stable connection need a defined route back into the repository.
  • Culture. If supervisors reward the fast online fix and never ask for the check-in, the history fills with gaps.

Back to octoplant version control and change management or the AMDT hub.

Frequently asked questions

What does check out mean in octoplant?

Checking out takes a copy of the latest approved version of a device's program or configuration from the octoplant repository so an engineer can work on it. AMDT describes the cycle as checking out the latest approved version, making changes in the familiar engineering tool, then creating and checking in a new version. It starts every planned change from a known reference rather than from whatever is on a laptop.

Does octoplant replace Studio 5000 or TIA Portal?

No. The edit itself happens in the vendor's own engineering software, such as Studio 5000, TIA Portal or a robot or HMI editor. octoplant manages the versions before and after the edit. That means every engineer still needs the correct, licensed version of the native tool, and octoplant's support for that tool and version should be confirmed against AMDT's current matrix.

Does check out lock the project so nobody else can edit it?

AMDT's public pages do not state whether a check-out locks a component against other users or how concurrent work is resolved. Ask AMDT or a partner to demonstrate what happens when two engineers check out the same project, because the answer shapes how you schedule shutdown work with several engineers and contractors on site at once.

What happens if an engineer edits a PLC online without checking it out?

The edit goes straight into the running controller and bypasses the repository. octoplant cannot stop that, but its scheduled change detection jobs compare the running device against the approved version and flag the difference. Someone then has to decide whether the edit becomes the new approved version through a proper check-in or is reversed.

Should contractors check in to our octoplant system?

In our view, yes, if the system is in place. A contractor who checks out from the plant's repository and checks in with comments leaves a record of exactly what changed during their work. That makes handover verifiable and limits the risk of a machine coming back with a program nobody on site can trace.

References and further reading

  1. About Octoplant · AMDTThe check-out, edit, check-in cycle and scheduled compare jobs, in AMDT's words.
  2. OT Change Management & Version Control · AMDTSmart Compare, drift detection and approval workflows.
  3. Versioning & Version Control Management · AMDT (octoplant.com)Role-based access to modify, approve or restore.
  4. SP 800-82 Rev. 3, Guide to Operational Technology (OT) Security · NISTSection 6.2.4.2 covers configuration change control; 6.2.4.3 covers backups.

← Version Control

Have a project that needs technical ownership?

Send us the situation. If it is not something we should take on, we will say so.