Omniverse Navigator (former Omniverse Web)¶

Interface Overview¶

Omniverse Navigator gives you web based control over the data in your Omniverse Nucleus.

Once logged in, you will be presented with the contents of your Nucleus.

Ref #	Option	Usage
1	Tree Navigation	Use for quick access to nested folders.
2	Content Browser	Lists the contents of the current directory selected in Tree Navigation.
3	Detail Panel	Shows details about the selected directory item.
4	Search Bar	Search for files in the File Tree of Nucleus
5	Copy URL	Copies the URL to the currently selected item.
6	Snapshot	Create a snapshot of the selection.
7	Permissions	Show & Set permissions assigned to the directory item.

Details Panel¶

When you select a directory item, the details panel reports information known about the asset.

Permissions Panel¶

The permissions panel allows you to control access to data.

Permission	Displayed As
Read	R	Grants Read Access to this principal
Write	W	Grants Write Access to this principal
Admin	A	Grants Admin Rights to this principal

To manage permissions see ACLs and Permissions Management

Version Control¶

Navigator creates and lists Checkpoints. The goal with Checkpoints is to provide historical versions for any change to the contents of a file that is done when you use Navigator.

Checkpoint on Upload¶

A Checkpoint is created for each individual file when they are uploaded. This way there is a restore point if the file was changed in some undesirable way. When you upload files you can enter a description that will be added to all the generated checkpoints.

Checkpoint on Rename, Move, and Copy¶

Checkpoints are created automatically for the destinations of Rename, Move, and Copy operations.

For Rename and Move the description states which source was used to replace the file contents.
For Copy the description states where the file was copied from.

Checkpoint Description on Copy and Rename

Delete¶

Deleting a file physically removes the head revision and all associated checkpoints from the server.

Deleting a folder deletes files in the same manner: the file head revisions in the folder are deleted and their associated checkpoints.

The Delete command physically deletes items and is not undoable.

Checkpoint Listing¶

All Checkpoints with descriptions are listed in the top category labeled Described checkpoints.
Other categories group checkpoints according to when they were created; for example, Today, Earlier this month, February 2020 and so on.
Hover over an item in the list to reveal a menu button.
The menu presents commands for the given Checkpoint: Copy URL, Download, and Restore. If your account is flagged as Administrator you would also see Obliterate in the menu.

Note: If the description for the checkpoint is longer than can be displayed in a single line, select the checkpoint and it’ll expand to reveal the entire description.

Menu Commands¶

Copy URL¶

Copies the Omniverse URL for the Checkpoint on the system clipboard.

Download¶

Downloads the file. Note that the filename for the downloaded file does not use the URL Schema for versioned files. Instead it uses the name of the head revision file. This is because the URL Schema makes use of characters that are not supported in all filesystem environments.

For example, car.usd?branch=default&checkpoint=42 will be downloaded as car.usd.

Restore¶

This command allows you to use the contents of the Checkpoint to update the head revision of the file.

Delete¶

Deleting a checkpoint physically removes it from the server. Action is not undoable.

Snapshots¶

Replaced by Version Control feature in Nucleus 2021.2.0

Create a Snapshot¶

Snapshots allow you to preserve state of a directory item for restoration at a later time. To create a snapshot, simply right click on any directory item and select “Create Snapshot”

This will open a dialogue allowing you to give the snapshot a name and a description.

Once created the selected directory item should now show the created snapshot in the details panel.

Restore a Snapshot¶

To restore a snapshot, simply right click on a snapshot and select “restore”

By default it will ask to overwrite the original directory item which may be desirable for tasks where paths and links are concerned. This will however overwrite the data with the snapshot.

If pathing is not a problem (standalone asset) you can freely adjust the path so as to not overwrite.

Once complete the Restore Operation will create the new directory and all its contents exactly in the state that the snapshot was originally created.

Asset Tagging¶

Omniverse Navigator provides additional functionality for tagging assets. This functionality requires the following services to be available:

Service	Description
Tagging service	Stores all the information about assets’s tags.
Deeptag Search Service (optional)	Enables tag searching functionality.

If an asset has tags associated with it, they will be visualized in the Tags tab, as depicted by the image below.

Working with Asset Tags¶

Users can add tags to assets by writing these tags into the text box and separating each new tag with a comma, as illustrated below.

In order to confirm new tags, one should press Enter and these tags will appear in the Tags tab of the asset, as shown in the image below.

Removing tags for an asset can be done in the similar manner.

User Administration¶

See Authentication and User Management