Editing and Managing Snapshots (2.11)
Snapshots are static copies of data in InterSystems Data Fabric Studio™, for future review. Once you have defined snapshots, you can run them, either on a schedule or manually. This page describes how to edit and manage them; another page describes the basics of defining them.
For convenience, snapshots can be in groups.
Viewing the Snapshots Dashboard
To view the Snapshots Dashboard, click the Snapshot icon in the application menu.
This page enables you to see all the snapshots; some or all of them might be in groups. In this display, the groups are listed alphabetically, followed by any snapshots that are in no groups. Within a group, the snapshots are listed alphabetically. You can specify the group, if any, to which a snapshot belongs.
For each snapshot, the page displays the following information.
-
Status—Status of the snapshot, which can be Idle, Running, or Error.
-
Snapshot Name—Name of the snapshot.
-
Snapshot Description—Description of the snapshot.
-
Table Name—Name of the table in which the current version of this snapshot is stored.
-
Life Cycle—Displays the life cycle state of the snapshot, which can be Active (the initial state), Disabled, or Deleted.
Only Active snapshots can be scheduled.
Click any snapshot in order to view it or make changes.
To filter the display, use the options above the column headers.
Editing a Snapshot
To edit a snapshot:
-
Click the Snapshot
icon in the application menu.
-
Click the snapshot you want to edit.
The snapshot definition is displayed.
-
Click Edit.
-
Make changes in the same way as when you create a snapshot.
If you change the SQL query used in the snapshot, click Parse Query so that the system can update the structure of the associated table, if needed. If the snapshot definition now defines a different set of columns, the system automatically generates a new table that has the required columns. The older table is left alone. The system displays an informational message about this change.
-
Click Save.
Or click Delete Draft to cancel your edits.
Moving a Snapshot Into or Out of a Group
You can move a snapshot into a group or out of all groups via drag and drop. The system also proves a menu option, as follows:
-
Click the Snapshot
icon in the application menu.
-
If the snapshot is currently in a group, expand that group.
-
Click the Menu
icon next to the snapshot name.
-
Click Move to other group.
-
Select a group name (or select Ungrouped if this snapshot should not be in any group).
Note that you cannot move a snapshot into a group that has been deleted.
Retagging a Snapshot Run
If you have run a snapshot, you can change that tag that is associated with any particular run of that snapshot. To do so:
-
Click the Business Scheduler
icon in the application menu.
The system displays a table that lists the items that are currently scheduled. If needed, use the filters at the top of the table to narrow down what is shown.
-
In the row for the task, right-click and select View Task, or double click the task. The run history is displayed.
-
In the row for the run that you want to retag, click the Edit
icon in the Snapshot Tag Name column.
Tip:The Edit icon won’t appear until the task is done running.
-
Type a new tag, up to 128 characters in length, and press Enter.
Disabling a Snapshot
To disable a snapshot so that it cannot be run:
-
Click the Snapshot
icon in the application menu.
-
Click the snapshot you want to disable.
The snapshot definition is displayed.
-
Click Disable.
-
Click Disable to confirm.
Enabling a Snapshot
To enable a previously disabled snapshot:
-
Click the Snapshot
icon in the application menu.
-
Click the snapshot you want to disable.
The snapshot definition is displayed.
-
Click Enable.
Deleting a Snapshot
To delete a snapshot:
-
Click the Snapshot
icon in the application menu.
-
Click the snapshot you want to delete.
The snapshot definition is displayed.
-
Click Delete.
-
Click Delete to confirm.
Recovering a Snapshot
You can recover deleted snapshots, but only if they belong to an active snapshot group or are ungrouped. Snapshots in deleted groups cannot be recovered unless the group is first restored.
To recover a deleted snapshot:
-
Click the Snapshot
icon in the application menu.
-
Select the Show deleted check box.
-
Click the deleted snapshot you want to recover.
The snapshot definition is displayed
-
Click Recover.
The snapshot is immediately restored and can now be used.