Omniverse Navigator (former Omniverse Web) ========================================== .. _Omni_Web: Interface Overview ------------------ Omniverse Navigator gives you web based control over the data in your |nuc|. Once logged in, you will be presented with the contents of your |nuc_short|. .. image:: ../../content/images/nucleus_web_main.png :align: center :alt: Omniverse Web Layout ======== ============================================== ========================================================================= 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 |nuc_short| 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. .. image:: ../../content/images/nucleus_web_details.png :align: center :alt: Details Panel Permissions Panel -------------------------- The permissions panel allows you to control access to data. .. image:: ../../content/images/nucleus_web_permissions.png :align: center :alt: Omniverse Web Permissions ============ ============= ========================================== 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 :ref:`RST_ACLs_And_Permissions` .. _Omni_Navigator_Version_Control: Version Control --------------------------- Navigator creates and lists :doc:`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. .. image:: ../../content/images/nucleus_web_upload_checkpoint_description.png :align: center :alt: Checkpoint Description on Upload 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. .. image:: ../../content/images/nucleus_web_automatic_checkpoint_descriptions.png :align: center :alt: 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 ######################### .. image:: ../../content/images/nucleus_web_checkpoint_list_narrow.png :align: center :alt: Checkpoint Listing 1. All Checkpoints with descriptions are listed in the top category labeled `Described checkpoints`. 2. Other categories group checkpoints according to when they were created; for example, `Today`, `Earlier this month`, `February 2020` and so on. 3. Hover over an item in the list to reveal a menu button. 4. 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 :ref:`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 --------------------------- :guilabel:`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" .. image:: ../../content/images/nucleus_web_create-snapshot-1.png :align: center :alt: Create Snapshot 1 This will open a dialogue allowing you to give the snapshot a name and a description. .. image:: ../../content/images/nucleus_web_create-snapshot-2.png :align: center :alt: Create Snapshot 2 Once created the selected directory item should now show the created snapshot in the details panel. .. image:: ../../content/images/nucleus_web_create-snapshot-3.png :align: center :alt: Create Snapshot 3 Restore a Snapshot ####################### To restore a snapshot, simply right click on a snapshot and select "restore" .. image:: ../../content/images/nucleus_web_restore-snapshot-1.png :align: center :alt: Restore Snapshot 1 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. .. image:: ../../content/images/nucleus_web_restore-snapshot-2.png :align: center :alt: Restore Snapshot 2 If pathing is not a problem (standalone asset) you can freely adjust the path so as to not overwrite. .. image:: ../../content/images/nucleus_web_restore-snapshot-3.png :align: center :alt: Restore Snapshot 3 Once complete the Restore Operation will create the new directory and all its contents exactly in the state that the snapshot was originally created. .. image:: ../../content/images/nucleus_web_restore-snapshot-4.png :align: center :alt: Restore Snapshot 4 Asset Tagging ------------------ Omniverse Navigator provides additional functionality for tagging assets. This functionality requires the following services to be available: .. table:: :align: center ============================================ ======================================================================================================================================================================================= 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. .. figure:: ../../content/images/nucleus_web_tags.png :width: 45% :align: center :alt: Nucleus Web Tagging tab 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. .. figure:: ../../content/images/nucleus_web_tags_add.png :width: 45% :align: center :alt: Nucleus Web Tagging tab add tag 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. .. figure:: ../../content/images/nucleus_web_tags_add_fin.png :width: 45% :align: center :alt: Nucleus Web Tagging tab add tag final Removing tags for an asset can be done in the similar manner. .. _RST OV_Web_User_Administration: User Administration ------------------------------ See :ref:`RST_Authentication_And_User_Management`