Access the web UI

The Helix Search web User Interface (UI) enables you to search submitted changes, file revisions, file content, and assets in your Helix Core Server.

Get the web address for the Helix Search web UI from your administrator and open the UI in your web browser.

For example, http://myhelixsearch.mydomain.com:1601

Tip

The actual URL and port number used depends on your system configuration.

In the header you have the following elements:

Image of the Helix Search web page

Switch language

Select Globe to change your language preference for the Helix Search UI. Currently, you can view the Helix Search UI in English, Japanese, and Chinese.

Get online help

To open the Helix Search help documentation, on the title bar, select Help.

Account

Select Account arrow to manage Helix Search:

  • Theme: select to change the Helix Search theme.
  • Search: select to search your Helix Server for submitted changes, file revisions, or file content.
  • Status: displays the overall status of the Helix Search system. See View status.
  • Configure (administrators only): select to open the Helix Search configuration page. See Configure Helix Search.
  • Logger (administrators only): select to view live logging details for the current log file, configure the log file, or manage the logs. See View live logs.
  • Indexing (administrators only): select to open the Helix Search indexing page, see Index Helix Search.
  • Sign Out: select to sign out of the Helix Search web user interface.

Search

Search your Helix Server for submitted changes, file revisions, or file content.

To make a search:

  1. If the search menu is not expanded, select Search to expand it.

  2. Select the type of search you want to make; Submitted Changes, File Revisions, File Contents, or Assets.

  3. Enter your search term in the Search box at the top of the page and press Enter.

    In the results, each file displays a ribbon with the name of the data model it belongs to.

    • Search exact match: wrap the your search term with quotes ". For example, to find results that exactly match foo.bar.bong enter:
    • "foo.bar.bong"

    • Search for a term-x and term-y (AND): To find results that contain term-x and term-y, separate your search terms with a space. For example, to find results that contain foo and bar enter the following search term:
    • foo bar

    • Search using a Domain specific language (DSL) query: To find results with different combinations you can use DSL queries. See Domain specific language query.

  4. To filter and order the results further, select the Filters button to the right of the Search box. For information about filters, see Filters below.

Filters

You can filter and order the results further using the Helix Search Filters.

To set the filter settings for a search type:

  1. From the Search menu, select the search type you want to set the filters for, Submitted Changes, File Revisions, File Contents, or Assets.

  2. Select Filters to the right of the Search box.

  3. The settings available depend on the search type selected:

    • Sort Field: sort by Change, Revision, FileName, User, Date, DepotFile, FileType, Action, or Client
    • Sort Order: Asc (ascending) or Desc (descending)
    • Depot File: enter a depotFile to search on
    • From and To: enter date and time to filter by
    • User: filter by username
      • Exact User Term: set to filter by exact username
    • Head Revision only: set to filter by head revisions only
    • Exclude Delete Action: set to filter by excluding deletes
  4. When you have set your filter options, select Apply Changes to filter your search.

  5. To reset the filters to the default values for the selected search type, select Reset filter to default values.