How to Save Collections and Shortcuts

This page describes how to:

  • Save and create search queries (grouping of results) as collections using the File view
  • Save file path locations as shortcuts to reuse in the Browse view

πŸ“˜

Who can create collections and shortcuts?

  • Organizational admins and Members have the ability to create and edit public collections or shortcuts. They can both share a collection/shortcut with the entire organization.
  • Read-only users can not create collections or shortcuts.

Saved collections display alphabetically at the top of the Search page, however, any collection you indicate as a favorite displays at the beginning of that list. If more than four collections were created, you can click > More to review and manage those collections to which you have access. The maximum number of collections/shortcuts per organization is 5,000.

πŸ“˜

Search Tetra Web API

For details about using Search in the Tetra Web API, click here.

Collections

How to Create and Save a Collection

Using the Search feature, you can create and save search queries (grouping of results) as a collection in the List view. A collection is a complex URL encoded Elasticsearch (ES) query, or succession of ES queries, as shown in this example:

http://localhost:3001/?p=0&q={"h":{"isNew":true,"active":"eee97170-83a3-48e4-91ba-410aefe4ad14/IDS/WAT12/Astrazeneca/TetraScience_dev_data/E19_015168_011119_Anion/3320/20191102500959dot-in-namejson","activePath":"di-5386-epic/eee97170-83a3-48e4-91ba-410aefe4ad14/IDS/WAT12/Astrazeneca/TetraScience_dev_data/E19_015168_011119_Anion/3320/20191102500959.json","activeFolderName":"20191102500959.json"},"d":"browse"}

To save a search query and create a collection:

  1. In the Tetra Data Platform, click the Hamburger icon near the top of the page.
  2. Select Search Files from the menu that appears on the left side of the page.
  3. From the Search page, click List to display the List view.
  4. Enter the terms and fields that you want to include in your query in the Search box and click Search.
  5. After you build the query you want, you can save the grouping of results by creating a collection. Click Save at the top right of the page.
  6. A dialog displays showing the selected filter criteria. Enter the name of your collection. The length of the name can be up to 100 characters, must be unique, and can include any alphanumeric characters except these: < > : " / \ | ? *
515

Create a Collection

  1. To add this new collection as a personal favorite for yourself, toggle the Add to personal favorites field. Additionally, if you are an Admin user, you can choose to make this collection available to your entire organization.
  2. Click + Create to create the new collection and add it to the top of the Search page.
  • If you saved the collection as a favorite, then a star notation displays next to the collection name. Any collections you created for yourself are private and are indicated with a lock next to the collection name.
  • If you are an Admin user and you chose to make this collection available to your entire organization, then a group notation displays next to the collection name.

After you create a collection, you can select it from the top of the Search page and immediately display the saved query.

How to Manage a Collection

After you create a collection, you can:

  • Review the collection's status and details
  • Change its query composition and update the collection
  • Add the query collection to another collection
  • Add/remove a favorite status to a collection
  • Show/hide a collection

To review a collection's status and details, you can hover over each collection to display details such as: name, visibility (private or organization), query, source type(s), and/or pipeline(s):

1848

Hover over Collection

To edit a collection:

  1. From the top of the Search page, click > More to review and manage those collections to which you have access.
1470

More dialog

  1. A dialog displays the list of existing collections. You can hover over each collection to display details such as: name, visibility (private or organization), query, source type(s), and pipeline(s).
  2. To edit a collection in the list, click Manage Collections. The Manage Collections dialog displays:
1067

Manage Collections

The collection's name, permission type (Just Me or Organization), its short ID, and when it was last updated display. Additionally, you can search for any collection by entering text in the Search bar, and copy its short ID to a clipboard.

  1. To edit the collection, hover over its Last Updated field to view the action icons: Edit Collection, Favorite/Unfavorite (star), and Show/Hide Collection (eye).
1075

Edit Collection Action Icons

  1. Click the Edit Collection icon to update the collection name, permission, and/or hidden status.
  2. Click + Update Collection.

To change an existing query's composition and update the collection:

  1. From the top of the Search page, select the collection you want to update.
  2. The selected collection is highlighted and its query details display.
1789

Selected Collection

  1. Edit the terms and fields in your query in the Search box and click Search.
  2. To save the new grouping of results, click Save at the top right of the page.
  3. From the dialog that displays, you can select to:
    - Update the selected collection with additional filters, and then click Update Current Collection.
    or
    - Create a brand new collection based on the selected collection with the additional filters, and then add a name for the new collection and click + Create.
523

Edit Existing Collection

To add/remove a favorite status to a collection:

  1. From the top of the Search page, click > More.
  2. A list of collections to which you have access displays. Click Manage Collections. The Manage Collections dialog displays:
1075

Favorite/Unfavorite Action

  1. Hover over the Last Updated column for the collection you want to change the favorite status.
  2. To mark a collection/or remove it as a personal favorite for yourself, you can:
  • Click the Edit Collection icon, and then toggle the Add to personal favorites field to add this collection as a personal favorite for yourself. Click + Update Collection. The newly favored collection now displays at the top of the Search page at the beginning of the list.
    To remove the collection as a favorite, you would toggle the Add to personal favorites field to off. Click + Update Collection.

  • Click the star icon in Last Updated column of the collection. A solid star is added directly next to the collection name indicating a favorite collection. The newly favored collection now displays at the top of the Search page at the beginning of the list.
    To remove (unfavorite) the favorite status from a collection, you would click the outlined star icon in Last Updated column. The solid star is deleted from the collection name and the collection now displays alphabetically at the top of the Search page.

To show/hide a collection from the list:

  1. From the top of the Search page, click > More.
  2. A list of collections to which you have access displays.
  • As an Admin, you can show/hide all collections
  • As a User, you can show/hide only those collections you created

πŸ“˜

Cannot remove collections

You cannot remove a collection; you can hide it only.

Click Manage Collections. The Manage Collections dialog displays:

1085

Show/Hide Action

  1. To show any hidden collections to which you have access, slide the Show Hidden toggle to the right. Any hidden collection now displays grayed out in the collection list:
1075

Show Hidden Collections

  1. To unhide a collection and show it in the list, click the Show Collection (eye) icon in Last Updated column of the collection. The collection is unhidden and no longer displays grayed out in collection list.
    To hide a collection, click the Hide Collection (eye with line) icon in Last Updated column of the collection. The collection is hidden and displays grayed out in collection list.

Sharing Collections

It is now easier to share links to collections with your team. You can create a collection of files and link that collection to your ELN so others from your team can view them. You can now share and use a shortened URL that only contains the collection id, such as:

https://{tetraDomainExample}.com/?&collectionId={collectionId}

Because this shortened collection url is static (it will always remain the same), even when changes are made to the search parameters, the same link will always direct to the most recent version of the collection.

Shortcuts

How to Create and Save a Shortcut

Using the Search feature in Browse view, you can save file path searches as a shortcut and add to the top of the My Home page. The ability to save file locations as shortcuts at an organizational and individual level enables you to quickly navigate your file structure and reuse folder searches without having to remember the entire Tetra Lake structure. Shortcuts do not apply to collections (queries).

πŸ“˜

Organizational-wide Shortcuts

Only an Admin user can create organizational-wide shortcuts.

To save file path searches and create a shortcut representing the folder location:

  1. In the Tetra Data Platform, click the Hamburger icon near the top of the page.
  2. Select Search Files from the menu that appears on the left side of the page.
  3. From the Search page, click Browse to display the Browse view. The Tetra Lake folders display as the source instead of the File Category, Source Type, and Pipeline. Each folder represents a location in the Tetra Lake and is a part of your organization's file hierarchy.
1898

Search Page in Browse View

  1. Select the folder(s) you want to include in the shortcut by navigating the folder hierarchy on the left of the Search page.
  2. After you navigate to the end location you want, click Shortcut next to the file path indicator at the top of the page:
1465

File Path for Shortcut

  1. From the New Shortcut dialog, enter the name of the shortcut. The length of the name can be up to 100 characters, must be unique, and can include any alphanumeric characters except these: < > : " / \ | ? *. Additionally if you are an Admin user, you can toggle to make this shortcut available to all users within your organization.
526

Create Shortcut

  1. Click + Create. The newly created shortcut is added to the My Home page display area. Shortcuts display alphabetically.
1443

Saved Shortcuts on My Home page

  • As a User, any shortcut you created displays with a lock icon on the folder indicating access permission is only for yourself.
  • As an Admin, any shortcut you created and made available to the entire organization displays with the crowd icon on the folder indicating access permission is for everyone.

To permanently hide an existing shortcut:

🚧

Hidden Shortcuts

Please be careful when deciding to hide an existing shortcut. You cannot unhide a hidden shortcut.

  1. Hover over the shortcut folder and click on the red β€œcross”.
  2. A confirmation dialog displays asking if you want to permanently hide the shortcut.
  3. Click Hide. The shortcut is removed from the My Home page.