-

Project Archive and Retain Data Management in the Web Based Management Tool

Version Number Description
1.0 Initial version


This application note shows how to manage the retained data (save and install) on an iC922x controller.

1. Supported Components

Component Name Version
iC9200 series ≥ 2024.9
iCube Engineer ≥ 2024.9

2. Solution Details

Make sure that the variables are checked as 'Retain' variables in the variable table.

Image

In the example shown below, the last value of 'retainCounter' on the running machine was 403 as shown below.

Image

Consider the scenario where this state of the machine needs to be frozen and the project needs to be replicated on another controller with this state.
Login to the Web Based Management system of the iC922x.
Go to the cockpit, Stop the PLC and save the retain data. Stopping the PLC is not a prerequisite for saving the retain data. However, stopping the PLC will ensure that the variable values are consistent with what was supposed to be saved.


Image

A message about data being saved should appear.

Image

The retained data files are stored in the /opt/plcnext/retaining/backups folder. Save the retained data file to your PC using SSH. In the example shown below, an SSH tool called snowflake is used to save the retained file to the PC.

Image

The archive page allows the user to receive the archive from the controller if the PLC is in stop state.

Image

The archive is saved on the PC in a zip format.

Image

On the new controller, make sure that the PLC is in stop state.
Send the saved archive from the first controller to the new controller.

Image

Reboot to make sure that the project starts running.
Once , the project is running, in iCE the user can connect to the controller and go to debug mode to check the variable value.

Image

It can be seen that the value has not yet been updated because the retain data has not been restored.
Use SSH to restore the retain data file to the new controller in the/opt/plcnext/retaining/backups folder.

Image

In the cockpit page, stop the PLC , and restore the retained data.

Image

Warm start the PLC.
Check the value of the retained variables in iCube Engineer. The retained data should be available for use.

Image


 


This help information is valid for iCube Engineer Online Help 2025.6

Copyright © 2025 YASKAWA EUROPE GmbH and © 2025 YASKAWA America, Inc.