v0.61.3
ReferenceRangesSnapshots

Snapshot tasks and schematics

Attach a read-only copy of a task or a schematic to a range to keep its configuration.

A snapshot is a read-only copy of a task or a schematic that Synnax attaches to a range. A task snapshot keeps the calibrations, scales, ports, and lines that the task used. A schematic snapshot keeps how the schematic looked.

A snapshot copies the configuration at the moment that you take it. Take it during the test, before anyone changes the task or the schematic. A snapshot copies no data.

Snapshot a task

  1. In the ranges toolbar, right-click a range that is saved to the Core and select Set as active range.
  2. In the tasks toolbar, right-click the task and select Snapshot to followed by the range name. You can select several tasks first.

The snapshot is named after the task, followed by (Snapshot).

Snapshot a schematic

  1. Make the range the active range.
  2. In the projects toolbar, right-click the schematic and select Snapshot to followed by the range name.

Open or delete a snapshot

Snapshots do not show in the tasks toolbar or the projects toolbar. To find them, open the range overview and go to Snapshots.

  • Click a snapshot to open it. You cannot change a task snapshot, start it, or stop it. You cannot edit or control a schematic snapshot.
  • Click the delete icon of a snapshot, then confirm, to delete it.

Deleting a range also deletes its snapshots.

Snapshots in code

A script takes a snapshot at a set point in a test, such as when a sequence starts. Copy a task or a schematic with snapshot set and the key of a range. To list the snapshots of a range, retrieve the tasks and the schematics that the range owns.

rng = client.ranges.retrieve(name="Oct 10 Burst Test")

# Take a snapshot of a task and of a schematic
client.tasks.copy(task.key, "Press task (Snapshot)", snapshot=True, range_key=rng.key)
client.schematics.copy(
    schematic.key, name="Press schematic (Snapshot)", snapshot=True, range=rng.key
)

# List the snapshots of the range
tasks = client.tasks.retrieve(ranges=[rng.key])
schematics = client.schematics.retrieve(ranges=[rng.key])

rng.snapshots() is a short form that returns the task snapshots of the range.