What is a Snapshot

Snapshot feature allows you to perform version control. You can take backup of your Workbook or Workflow at any point of time. These snapshots can be restored as and when required. Snapshot feature is available in Workbook as well as Workflow. It is present in the canvas on the function pane.
Snapshot can be used in both Workbooks and Workflows.
You can use Snapshot when you are,

  • Creating a new Workbook or Workflow
  • Editing an existing Workbook or Workflow

Figure: Snapshot

Taking a Snapshot

rubiscape provides facility to take snapshots of the workbook canvas. A snapshot is a backup of the configuration of the workbook at a given point in time which can be saved and restored later as required. It is used for version control, so you can roll back to any instance of your algorithm design.

(info)

Notes:

  • Snapshots can be saved with or without the algorithm result.
  • Snapshot name is system-generated. You can enter description for your snapshot.
  • Snapshots are workbook specific. You can restore snapshots saved within the same workbook.

To take a snapshot, follow the steps given below.

  1. Create a new Workbook or Workflow. Refer to Creating a Workbook or Creating a Workflow.

    (info) Note:

    Alternatively, open an existing Workbook or Workflow. Refer to Opening a Workbook or Opening a Workflow.

  2. Start building a new algorithm flow or edit the existing algorithm flow in the workbook as required.
  3. To make sure your changes are saved, click Save icon ( ) to save it.
  4. Click the ellipsis ( ) located on the function pane.
  5. From the options displayed, click the Snapshot icon ( ).
    The Snapshot page is displayed.
  6. Click Create Snapshot.

    Figure: Snapshot Window

    Create Snapshot page is displayed.
  7. Enter a Description for your snapshot.

    (info)Note:

    To store the result of the algorithm along with your snapshot, select the Include Result check box. This check box is clear by default.

  8. Click Create Snapshot.
    The snapshot of your algorithm is saved. You can restore it later.


    Figure: Create Snapshot

Restoring a Snapshot

You can restore a snapshot that was created earlier. Remember to save your current workbook status before restoring a snapshot to avoid losing of any unsaved work.
To restore a snapshot, follow the steps given below.

  1. Open an existing Workbook or Workflow. Refer to Opening a Workbook or Opening a Workflow.

    (info)Note:

    Snapshots are workbook specific. You can restore snapshots only from the same workbook where you have stored the snapshots. So, open the required workbook.

  2. Click the ellipsis ( ) located on the function pane.
  3. From the options displayed, click the Snapshot icon ( ).
    A list of available snapshots is displayed.
  4. Hover over the snapshot you want to restore, click the ellipsis ( ) corresponding to it, and then click Restore.


    Figure: Restoring a Snapshot
    A message to confirm your action is displayed.
  5. Click Restore to confirm.
    The selected snapshot is restored.

Deleting a Snapshot

You can delete a snapshot that is not required.

(warning) Warning:

This action cannot be undone.


(info)

Notes:

  • Deleting a snapshot does not affect your canvas.
  • You can take a new snapshot to save the current version of your algorithm flow.


To delete a snapshot, follow the steps given below.

  1. Open an existing Workbook or Workflow. Refer to Opening a Workbook or Opening a Workflow.

    (info)Note:

    Snapshots are workbook specific. You can restore snapshots only from the same workbook where you have stored the snapshots. So, open the required workbook.

  2. Click the Snapshot icon ( ) located on the function pane.
    A list of available snapshots is displayed.
  3. Hover over the snapshot you want to delete, click the ellipsis ( ) corresponding to it, and then click Delete.

    Figure: Deleting a Snapshot

    A message to confirm your action is displayed.
  4. Click Delete to confirm.
    The selected snapshot is deleted and a confirmation message is displayed.




Table of Content