Artifact Version Manager User Guide (Limited Availability)

Learn how to manage, review, and approve new artifact versions across your TDP environments by using the Artifact Version Manager.

This guide describes how to use the prerelease versions of Artifact Version Manager to manage, review, and approve new artifact versions across your Tetra Data Platform (TDP) environments.

📘

NOTE

This guide covers the limited availability release of the Artifact Version Manager. Features and workflows described here may change in future releases.

Access Artifact Version Manager

📘

NOTE

To activate the Artifact Version Manager for your organization, see Activate Artifact Version Manager.

To access Artifact Version Manager, do the following:

  1. Sign in to the TDP as a user with Admin permissions.
  2. In the left navigation menu, choose Administration. Then, select Artifact Version Manager.

Artifact Version Manager menu option

The Artifact Version Manager page displays a list of available artifacts, including the current version, newest version, and review status for each artifact. You can search for specific artifacts by name using the Search bar.

Artifact Version Manager

Artifact Version Statuses

The following table describes the statuses that an artifact version can have in the Artifact Version Manager.

StatusDescription
NewA new artifact version is available but has not been reviewed.
ReviewThe artifact version is under review by an authorized user. The Review status appears only after an artifact version is selected and viewed by an admin.
ApprovedThe artifact version has been approved and is available to users in the target TDP environment.
CancelledThe artifact version has been cancelled and is not available for activation.

Review a New Artifact Version

To review a new artifact version, do the following:

  1. Open Artifact Version Manager.
  2. Find the artifact that has a new version available. New versions display a New Version v[#] Available status.

New version tile

  1. Select the artifact version. That version of the artifact appears in the UI for review. In Artifact Version Manager, the artifact version's status changes to Review.

After reviewing the latest artifact version, you can go back to Artifact Version Manager to either approve or cancel it.

Approve an Artifact Version

To approve an artifact version, do the following:

  1. Open Artifact Version Manager.
  2. Find the artifact that you want to approve a new version for. The artifact's tile shows that it's in Review status.
  3. Select the Manage Versions button to view the artifact's version details.
  4. Find the artifact version that you want to approve. Then, select Activate in that version's row. The version status changes to Approved, and the artifact version becomes available to users in your TDP environment.
  5. (Optional) To make the approved version the default version that appears for all users, select Set Default.

Activate an artifact version

🚧

IMPORTANT

Approving a new version replaces the currently active version for all users in the environment. Verify that the new version has been tested before you approve it in a production environment.

Cancel an Artifact Version

To cancel an artifact version and roll back to the previous version, do the following:

  1. Open Artifact Version Manager.
  2. Find the artifact version that you want to cancel.
  3. Select the Manage Versions button to view its version details.
  4. Find the artifact version that you want to Cancel. Then, select Cancel in that version's row. The version status changes to Cancelled and the artifact version is no longer available for approval.

Cancel artifact version

Refresh List of Available Artifacts

The Artifact Version Manager synchronizes with the platform registry to ensure that the latest published artifact versions are available.

To manually refresh the list of available artifacts, do the following:

  1. Open Artifact Version Manager.
  2. Select Refresh Artifacts to pull the latest available artifact versions from the platform registry.
  3. After the sync completes, any new artifact versions appear in the list with a New Version v[#] Available status.

📘

NOTE

Depending on your organization's configuration, synchronization may occur automatically at regular intervals. Contact your administrator to verify your sync settings.

Documentation Feedback

Do you have questions about our documentation or suggestions for how we can improve it? Start a discussion in TetraConnect Hub. For access, see Access the TetraConnect Hub.

📘

NOTE

Feedback isn't part of the official TetraScience product documentation. TetraScience doesn't warrant or make any guarantees about the feedback provided, including its accuracy, relevance, or reliability. All feedback is subject to the terms set forth in the TetraConnect Hub Community Guidelines.