Configuring Backup and Restore Sequences

A sequence is the ordered list of steps OT Backup runs when it backs up or restores equipment. Sequences are one of the most important configuration areas: they decide which adapter/storage steps run, in which order, with which parameters, and whether the work runs on the server or on an agent.

flowchart LR
  E[Equipment or Equipment Type] --> B[Backup Sequence]
  E --> R[Restore Sequence]
  B --> S1[Step 1]
  B --> S2[Step 2]
  R --> S3[Step 1]
  R --> S4[Step 2]
  S1 --> Storage[(Backup Storage)]
  S4 --> Storage

Where sequences are configured

Sequences can be configured in two places:

The same Edit sequence dialog is used in both places.

Backup sequence vs. restore sequence

For most equipment, both sequences should include a step that connects to the device and a step that interacts with Backup Storage. The equipment page warns if a backup/restore sequence is missing a Backup Storage step.

Opening the sequence editor

From the Equipment form or an Equipment Type, choose:

• Add Backup Sequence or Edit Backup Sequence
• Add Restore Sequence or Edit Restore Sequence

The dialog title is Edit sequence.

If you close the dialog with unsaved changes, OT Backup asks:

You have unsaved changes that will be lost if you close this dialog. Are you sure?

Choose OK to apply the sequence to the form, or Cancel to close without applying it.

Layout of the sequence editor

The editor is split into two main areas:

Steps in sequence

Each step in Steps in sequence can be expanded to edit its parameters.

Available controls:

Step order matters. Later steps can depend on files, outputs or variables created by earlier steps.

Template steps

The Template steps tab lists the steps available for the current sequence type. Backup-only steps are shown for backup sequences, restore-only steps for restore sequences, and shared steps for both.

Available controls:

Some steps can run only on a specific worker. Open Show documentation to see an Agent only or Server only chip when a step has this restriction. A step without a worker chip can run on either worker.

Which steps are visible here is controlled by Configuration → Template Steps. Hidden template steps are not available when editing a sequence, but sequences that already use them continue to run.

Variables

The Variables tab lists substitution variables that can be used in parameters. It shows Name and Value columns.

The alert says Click row to copy name to clipboard. Select a variable row to copy its name, then paste it into a parameter field that supports variables.

Editing step parameters

Each step defines its own parameters. The editor renders the correct field type for each parameter:

Most parameters show inline descriptions when documentation is available for the step.

Step definition updates

Saved sequences retain configured values and resolve their labels, field types, choices, descriptions, and validation rules from the current adapter definition. Adapter updates can therefore improve display metadata without requiring users to recreate a sequence. A step or parameter's internal name is its stable identity; renaming it can prevent existing saved sequences from matching the updated definition. Removed parameters are retained as legacy parameters when an older sequence is resolved, allowing their values to be reviewed during migration.

Source and target storage

Source/Target parameters use the storage editor.

Depending on the step, it can show:

For backup sequences, storage steps normally write to Backup Storage. For restore sequences, storage steps normally read from Backup Storage.

Run on Agent and worker compatibility

The Run on Agent checkbox selects the worker for the entire sequence.

Each step can support both workers or require one worker type. The editor checks every step against the selected worker whenever you add a step or change Run on Agent.

If a step cannot run on the selected worker:

• The step is highlighted and shows an error icon.
• Hover over the icon to see which worker the step requires and which worker the sequence currently uses.
• OK is disabled while any worker mismatch remains.

Resolve the error by changing Run on Agent when every step supports the other worker, or remove/replace the incompatible step. For example, Custom Script, Start Process and Stop Process currently require an Agent worker.

Worker validation does not check whether an agent is assigned to the equipment. For an Agent sequence, also choose a Select Agent value on each equipment that uses the sequence. Equipment Types supply the sequence, but the individual equipment supplies the agent.

The TEE validates worker compatibility again before executing a job. This also protects sequences created before the editor validation was added. If an incompatible sequence reaches execution, the job fails before running any step and its log identifies the step, required worker and current worker.

This choice matters for network access. The machine running the sequence must be able to reach the PLC, robot controller, file share or other target.

Network requirements

When selected steps declare required ports, the editor shows a Network Requirements panel.

It lists:

Use this panel when preparing firewall rules between the server/agent and the device network.

Recommended workflow

1. Choose the right Equipment Type or open the specific Equipment.
2. Open Add/Edit Backup Sequence or Add/Edit Restore Sequence.
3. Add the adapter/storage steps from Template steps and review any Agent only or Server only requirements.
4. Put the steps in the order they should run.
5. Fill in required parameters.
6. Choose Run on Agent or Server execution and resolve every highlighted worker mismatch.
7. For Agent execution, confirm that each equipment has an agent selected.
8. Review Network Requirements.
9. Use OK to apply the sequence.
10. Save the Equipment or Equipment Type.
11. Run a test backup or restore and review the job log.

Troubleshooting

See Also

• Managing Equipment
• Configuring OT Backup
• Adapters
• Adapter SDK