Post-Artifact Editing Workflow

Checkpoint Flow

Saving Changes Locally

Users first save the changes to their sandbox. These changes remain local and are not visible to other users until published.

Creating a Checkpoint

Checkpoints are for the whole sandbox and not associated with projects. To create a checkpoint, proceed as follows.

1. Right-click anywhere in the Project Explorer view and select Checkpoint>Create OR In the Checkpoints view, click the Create Checkpoint toolbar button .
2. Enter the Name of the checkpoint.
3. Enter the Description (optional) which contains the purpose or details of the changes.

The checkpoint is saved in the sandbox, capturing the current state of the artifacts and projects.

Viewing Checkpoints

To view the list of created checkpoints, select Window>Show View>Checkpoints in the top-level menubar.

The Checkpoints view displays the following details:

• Date: Creation date of the checkpoint.
• Name: Name of the checkpoint.
• Description: Description of the checkpoint.
• Author: Creator of the checkpoint.

Making Additional Changes

If users make further changes after creating a checkpoint, such as updating the project version, they can create additional checkpoints to save the progress. Each checkpoint is independently named and described, ensuring incremental tracking of modifications.

Discarding the Modifications

To discard all pending modifications in the sandbox, right-click anywhere in the Project Explorer view and select Checkpoint>Discard modifications.

Purpose: Remove all modifications since the last checkpoint.

Behavior: All unsaved changes are permanently discarded. Changes captured in the last checkpoint or previously published versions remain unaffected.

Usage: Use this option for quick cleanup when modifications are no longer required.

Warning: This action cannot be undone. Ensure that the changes are no longer needed before discarding.

Resetting the Sandbox

To reset the sandbox, right-click on the project in the Project Explorer view and select Checkpoint>Reset Sandbox.

Purpose: Revert the sandbox to its original state before any checkpoints were created, syncing it with the backing space.

Behavior: Deletes all checkpoints in the sandbox and synchronizes the sandbox with the current state of the backing space. Any unsaved changes are preserved as pending changes unless explicitly discarded.

Usage: Useful for clearing all progress and aligning the sandbox with the latest version in the backing space.

Warning: Checkpoints cannot be recovered once deleted during this operation.

Reset to Checkpoint

To reset to a specific checkpoint, right-click on the project in the Project Explorer view and select Checkpoint>Reset to Checkpoint.

Purpose: Allows to reset to a specific checkpoint, the latest checkpoint, or the initial checkpoint.

Behavior: Only the changes made after the selected checkpoint are discarded. The sandbox is restored to the exact state of the chosen checkpoint.

Usage: Choose the desired checkpoint from the list and confirm the reset operation. Useful for rolling back to a specific stable state while retaining earlier progress.

Warning: Ensure that the selected checkpoint represents the desired state, as changes after that point are lost.

These options allow users to manage their workspace, ensuring flexibility and control while maintaining the integrity of their project workflows.

Preconditions

The user requires publish permission to the backing space or else it fails.

Update the Project Version

Before creating a checkpoint, ensure that all projects' versions have been updated. A project that is published to the backing space must have a unique version.

No Modified Files

Ensure that all changes are saved and included in the checkpoint. There should be no modified files left in the sandbox to avoid conflicts or incomplete publishing.

Steps to Publish a Checkpoint

Using the Context Menu

To publish the latest checkpoint, proceed as follows.

1. Right-click anywhere in the Project Explorer view and select Checkpoint>Publish.
2. Confirm the publish operation in the Publish Checkpoint dialog.

Using the Checkpoints View

To publish a specific checkpoint, proceed as follows.

1. On the top-level menubar, select Window>Show View>Checkpoints to open the Checkpoints View.
2. Locate the desired checkpoint in the Checkpoints View list. Right-click on the checkpoint and select Publish OR Select the checkpoint in the Checkpoints View and click the Publish toolbar button .